Leverage upper-constraints files to pin all dependencies
[holmes/rule-management.git] / docs / platform / consumedapis.rst
index d7ce362..640deef 100644 (file)
@@ -4,7 +4,7 @@
 Consumed APIs
 -------------
 
-In the Amsterdam release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB.
+In the Istanbul release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB.
 
 DCAE
 ^^^^
@@ -17,28 +17,34 @@ A&AI
 In order to get the correlation between different alarms with the help of the topological information provided by A&AI. Holmes needs to call the A&AI APIs. Generally, we have to query the information of VNFs, VMs and the corresponding relation between resources from different layers. The following APIs are invoked by Holmes.
 
 #. Query a VNF by name:
+
    ``/aai/v11/network/generic-vnfs/generic-vnf?vnf-name={vnf-name}``
 
 #. Query a VNF by ID:
+
    ``/aai/v11/network/generic-vnfs/generic-vnf?vnf-id={vnf-id}``
 
 #. Query a VM by name:
+
    ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-name:EQUALS:{vserver-name}``
 
 #. Query a VM by ID:
-   ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-id:EQUALS:{vserver-id}`` 
+
+   ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-id:EQUALS:{vserver-id}``
 
 More details could be found at `A&AI APIs <https://wiki.onap.org/pages/viewpage.action?pageId=13598793>`_.
+
 DMaaP
 ^^^^^
 
 Holmes fetches VES data from DMaaP and publishes the control loop event back to DMaaP. The related APIs are:
 
 #. Subscribing:
-   ``events/{topic}/{consumergroup}/{consumerid}``
+
+   ``/events/{topic}/{consumergroup}/{consumerid}``
 
 #. Publishing:
+
    ``/events/{topic}``
 
 More details could be found at `DMaaP APIs <https://wiki.onap.org/display/DW/DMaaP+API>`_.