openstack/vitrage
Code Issues Proposed changes

Repair the topology interface in api doc

Browse Source 
The response of /v1/topology  should be tree structure and  an inclusive relationship.
In this document it is actually a graph structure, but the graph_type parameter is tree.
In our vitrage , the tree type and graph type is both  very important ,I think it is better
 to write an example for both interfaces.

Change-Id: I0dc100f1c6c49615b82613551477c3851f0836e8
This commit is contained in:
Q.hongtao 2020-03-30 17:22:52 +08:00
parent 6c3bb2fd5d
commit a6d7332e89
1 changed files with 114 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -215,10 +215,6 @@ Response Examples
::
{
"directed": true,
"graph": {},
"nodes": [
{
"vitrage_id": "96f6a30a-51eb-4e71-ae4a-0703b21ffa98",
"name": "openstack.cluster",
@ -232,8 +228,8 @@ Response Examples
"vitrage_is_placeholder": false,
"id": "OpenStack Cluster",
"is_real_vitrage_id": true,
"vitrage_is_deleted": false
},
"vitrage_is_deleted": false,
"children": [
{
"vitrage_id": "12b11320-a6de-4ce5-892f-78fb1fa6bfef",
"name": "nova",
@ -248,12 +244,28 @@ Response Examples
"vitrage_is_placeholder": false,
"id": "nova",
"is_real_vitrage_id": true,
"vitrage_is_deleted": false
},
"vitrage_is_deleted": false,
"children": [
{
"vitrage_id": "5f9893b8-c622-4cb8-912d-534980f4e4f9",
"name": "devstack-rocky-8",
"update_timestamp": "2018-06-11 08:43:33.518059+00:00",
"vitrage_category": "RESOURCE",
"vitrage_operational_state": "OK",
"state": "available",
"vitrage_type": "nova.host",
"vitrage_sample_timestamp": "2018-06-11 08:43:33.757864+00:00",
"graph_index": 2,
"vitrage_aggregated_state": "AVAILABLE",
"vitrage_is_placeholder": false,
"id": "devstack-rocky-8",
"is_real_vitrage_id": true,
"vitrage_is_deleted": false,
"children": [
{
"vitrage_id": "c90cc1dd-409c-4354-92f8-79b993e584c0",
"vitrage_is_deleted": false,
"graph_index": 2,
"graph_index": 3,
"vitrage_category": "RESOURCE",
"vitrage_operational_state": "N/A",
"vitrage_type": "nova.instance",
@ -266,7 +278,7 @@ Response Examples
{
"vitrage_id": "94060508-5fea-4927-9a53-2b66864ab883",
"vitrage_is_deleted": false,
"graph_index": 3,
"graph_index": 4,
"vitrage_category": "RESOURCE",
"vitrage_operational_state": "N/A",
"vitrage_type": "nova.instance",
@ -278,7 +290,7 @@ Response Examples
},
{
"vitrage_id": "ae0886d8-ee90-41df-a80a-006fdb80105b",
"graph_index": 4,
"graph_index": 5,
"name": "vm-4",
"update_timestamp": "2018-06-11 08:43:34.421455+00:00",
"vitrage_category": "RESOURCE",
@ -296,7 +308,7 @@ Response Examples
},
{
"vitrage_id": "4d197913-0687-4300-afb7-7fd331d35cff",
"graph_index": 5,
"graph_index": 6,
"name": "vm-3",
"update_timestamp": "2018-06-11 08:43:34.421490+00:00",
"vitrage_category": "RESOURCE",
@ -311,55 +323,12 @@ Response Examples
"id": "12cc6d3e-f801-4422-b2a0-43cedacb4eb5",
"is_real_vitrage_id": true,
"vitrage_is_deleted": false
},
{
"vitrage_id": "5f9893b8-c622-4cb8-912d-534980f4e4f9",
"name": "devstack-rocky-8",
"update_timestamp": "2018-06-11 08:43:33.518059+00:00",
"vitrage_category": "RESOURCE",
"vitrage_operational_state": "OK",
"state": "available",
"vitrage_type": "nova.host",
"vitrage_sample_timestamp": "2018-06-11 08:43:33.757864+00:00",
"graph_index": 6,
"vitrage_aggregated_state": "AVAILABLE",
"vitrage_is_placeholder": false,
"id": "devstack-rocky-8",
"is_real_vitrage_id": true,
"vitrage_is_deleted": false
}
],
"links": [
{
"relationship_type": "contains",
"source": 0,
"vitrage_is_deleted": false,
"key": "contains",
"target": 1
},
{
"relationship_type": "contains",
"source": 1,
"vitrage_is_deleted": false,
"key": "contains",
"target": 6
},
{
"relationship_type": "contains",
"source": 6,
"vitrage_is_deleted": false,
"key": "contains",
"target": 4
},
{
"relationship_type": "contains",
"source": 6,
"vitrage_is_deleted": false,
"key": "contains",
"target": 5
]
}
],
"multigraph": true
]
}
]
}
Show RCA