+.. _didm-developer-guide:
DIDM Developer Guide
====================
Key APIs and Interfaces
-----------------------
+.. _didm-flow-objective-api:
+
FlowObjective API
~~~~~~~~~~~~~~~~~
Install the Forwarding Objective:
-`http://<CONTROLLER-IP>:8181/restconf/operations/atrium-flow-objective:forward <http://<CONTROLLER-IP>:8181/restconf/operations/atrium-flow-objective:forward>`__
----
+``http://<CONTROLLER-IP>:8181/restconf/operations/atrium-flow-objective:forward``
Install the Filter Objective
-`http://<CONTROLLER-IP>:8181/restconf/operations/atrium-flow-objective:filter <http://<CONTROLLER-IP>:8181/restconf/operations/atrium-flow-objective:filter>`__
----
+``http://<CONTROLLER-IP>:8181/restconf/operations/atrium-flow-objective:filter``
Install the Next Objective:
-`http://<CONTROLLER-IP>:8181/restconf/operations/atrium-flow-objective:next <http://<CONTROLLER-IP>:8181/restconf/operations/atrium-flow-objective:next>`__
----
+``http://<CONTROLLER-IP>:8181/restconf/operations/atrium-flow-objective:next``
Flow mod driver API
~~~~~~~~~~~~~~~~~~~
-The Beryllium release includes a flow mod driver for the HP 3800. This
+This release includes a flow mod driver for the HP 3800. This
driver adjusts the flows and push the same to the device. This API takes
the flow to be adjusted as input and displays the adjusted flow as
output in the REST output container. Here is the REST API to adjust and
---------------------------
Go to
-`http://${controller-ip}:8181/apidoc/explorer/index.html <http://${controller-ip}:8181/apidoc/explorer/index.html>`__,
+http://${controller-ip}:8181/apidoc/explorer/index.html,
and look under DIDM section to see all the available REST calls and
tables