Skip to content
Snippets Groups Projects
Commit 6bbe2cf7 authored by Nikolay Stanchev's avatar Nikolay Stanchev
Browse files

Updates documentation of graph API

parent c4ce840f
No related branches found
No related tags found
No related merge requests found
......@@ -301,7 +301,7 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
This API method sends a request to run the Cypher Round-Trip-Time query over a temporal graph associated with a request UUID (retrieved from the response of a build-graph request).
The request UUID must be given in the request URL, e.g. request sent to */graph/temporal/75df6f8d-3829-4fd8-a3e6-b3e917010141/round-trip-time?startpoint=DC2&endpoint=minio_1_ep1*,
which will return the RTT breakdown for the path starting at Cluster DC2 to SF endpoint minio_1_ep1.
which will return the RTT breakdown for the path starting at Cluster DC2 to SF endpoint minio_1_ep1. The startpoint can be a Cluster, Switch, or UserEquipment node.
* Response:
......@@ -343,7 +343,7 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
}
```
Here, the *forward_latencies* and *reverse_latencies* lists represent the reported latency at each hop between switches/clusters. For example, if the path was DC2-DC3-DC4 and the SF endpoint was hosted
Here, the *forward_latencies* and *reverse_latencies* lists represent the reported latency at each hop between switches/clusters/ues. For example, if the path was DC2-DC3-DC4 and the SF endpoint was hosted
on DC4, the response data shows that latency(DC2-DC3) = 22, latency(DC3-DC4) = 11, latency(DC4-DC3) = 11, latency(DC3-DC2) = 22, response_time(minio_1_ep1) = 15.75
N.B. if the endpoint is hosted on the cluster identified in the URL parameter, then there will be no network hops between clusters/switches, so the latency lists would be empty, example:
......@@ -378,7 +378,7 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
* Response:
The response to this request is a JSON content which shows how many Switch and Cluster nodes were created in the graph.
The response to this request is a JSON content which shows how many Switch, Cluster and UserEquipment nodes were created in the graph.
Returns a 503 Service Unavailable error if the SDN controller cannot be reached.
......@@ -389,7 +389,8 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
```json
{
"new_switches_count": 12,
"new_clusters_count": 5
"new_clusters_count": 5,
"new_ues_count": 3
}
```
......@@ -399,14 +400,15 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
* Response:
The response to this request is a JSON content which shows how many Switch and Cluster nodes were deleted from the graph.
The response to this request is a JSON content which shows how many Switch, Cluster and UserEquipment nodes were deleted from the graph.
* Response Body Example:
```json
{
"deleted_switches_count": 12,
"deleted_clusters_count": 5
"deleted_clusters_count": 5,
"deleted_ues_count": 3
}
```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment