Docs add restconf use instructions

Add usage instructions for rest adapter to the
user guide.

Change-Id: I3fe1b9661c82ff789969987ddc18d7687fd41107
Signed-off-by: Patrick Brady <patrick.brady@att.com>
Issue-ID: APPC-1274

diff --git a/docs/APPC User Guide/APPC User Guide.rst b/docs/APPC User Guide/APPC User Guide.rst
index 620acd4..82bbaa9 100644 (file)
--- a/docs/APPC User Guide/APPC User Guide.rst
+++ b/docs/APPC User Guide/APPC User Guide.rst
@@ -342,11 +342,59 @@ Southbound VNF Adapters
     platform, while other adapters have been added by the ONAP\r
     development.\r
 \r
-Restconf Adapter \r
+Restconf Adapter\r
 ^^^^^^^^^^^^^^^^^\r
 \r
     The Adapter is responsible for configuration tasks, using JSON\r
     format, for VNFs supporting Restconf API.\r
+    \r
+**Using the Restconf Adapter**\r
+     The restconf adapter is normally called from a directed graph.\r
+     An "execute" node block should be used in the directed graph to\r
+     the "org.onap.appc.adapter.rest.RestAdapter" plug-in. There are\r
+     several methods available to use:\r
+\r
+- commonGet\r
+- commonDelete\r
+- commonPost\r
+- commonPut\r
+     \r
+There are several parameters that the RestAdapter plug-in takes\r
+\r
+org.onap.appc.instance.URI\r
+  The url that the rest request will be made to\r
+org.onap.appc.instance.requestBody\r
+  The body of the rest request\r
+org.onap.appc.instance.headers\r
+  The header of the rest request\r
+org.onap.appc.instance.haveHeader\r
+  true/false value which specifies if a header is present.\r
+  (Should be set to "true" if the org.onap.appc.instance.headers\r
+  parameter is defined, or set to "false" if the\r
+  headers parameter is not defined)\r
+  \r
+There are several parameters returned back to the DG from the RestAdapter\r
+\r
+org.onap.rest.result.code\r
+  An http code representing if the request completed. Will always be 200\r
+  if the request completes. See the below parameter for the exact http code\r
+  that gets returned.\r
+org.onap.rest.agent.result.code\r
+  The http code returned from the rest request.\r
+org.onap.rest.agent.result.message\r
+  The status or body returned from the rest request.\r
+  \r
+An example execute node:\r
+\r
+::\r
+\r
+<execute plugin='org.onap.appc.adapter.rest.RestAdapter' method='commonPut' >\r
+<parameter name='org.onap.appc.instance.URI' value='`$restUrl`'/>\r
+<parameter name='org.onap.appc.instance.requestBody' value='`$jsonContent`'/>\r
+<parameter name='org.onap.appc.instance.headers' value='{"Content-type":"application/json"}'/>\r
+<parameter name='org.onap.appc.instance.haveHeader' value='true'/>\r
+    \r
+    \r
 \r
 Netconf Adapter\r
 ^^^^^^^^^^^^^^^\r