Fixed publish config issue

[appc.git] / docs / APPC LCM API Guide / APPC LCM API Guide.rst

diff --git a/docs/APPC LCM API Guide/APPC LCM API Guide.rst b/docs/APPC LCM API Guide/APPC LCM API Guide.rst
index 73d558e..a8dffbe 100644 (file)
--- a/docs/APPC LCM API Guide/APPC LCM API Guide.rst
+++ b/docs/APPC LCM API Guide/APPC LCM API Guide.rst
@@ -796,9 +796,9 @@ The Audit action does not require any payload parameters.
 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 |     **Parameter**    |     **Description**                                                                                                                                       |     **Required?**   |     **Example**                  |
 +======================+===========================================================================================================================================================+=====================+==================================+
-|     publish-config   |     \* If the publish\_config field is set to Y in the payload, then always send the running configuration from the VNF using the message bus             |     Yes             |     "publish-config": "<Y\|N>"   |
+|     publish-config   |     \* If the publish\-config field is set to Y in the payload, then always send the running configuration from the VNF using the message bus             |     Yes             |     "publish-config": "<Y\|N>"   |
 |                      |                                                                                                                                                           |                     |                                  |
-|                      |     \* If the publish\_config field is set to N in the payload, then:                                                                                     |                     |                                  |
+|                      |     \* If the publish\-config field is set to N in the payload, then:                                                                                     |                     |                                  |
 |                      |                                                                                                                                                           |                     |                                  |
 |                      |     - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration                      |                     |                                  |
 |                      |                                                                                                                                                           |                     |                                  |
@@ -980,6 +980,40 @@ Request Payload Parameters:
 |                         | be specified.                          |                 |                                                       |
 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
 
+ConfigModify Request
+^^^^^^^^^^^^^^^^^^^^
+
+    Examples::
+
+              {
+                     "input": {
+                          "common-header": {
+                              "timestamp": "2017-10-25T11:10:04.244Z",
+                              "api-ver": "2.00",
+                              "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
+                              "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
+                              "sub-request-id": "1",
+                              "flags": {
+                                  "force": "TRUE",
+                                  "ttl": 60000
+                              }
+                          },
+                          "action": "ConfigModify",
+                          "action-identifiers": {
+                              "vnf-id": "<VNF_ID>"
+                          },
+                          "payload": "{ \"config-url\":\"5f517fd4-bf3d-43bc-8147-1b61776d7ded\",
+                                        \"config-json\": \"{\"pg-streams\":{
+                                        \"pg-stream\": [{ \"id\":\"fw_udp1\", \"is-enabled\": \"true\" }, 
+                                        {\"id\": \"fw_udp2\", \"is-enabled\":\"true\" }, 
+                                        { \"id\": \"fw_udp3\",\"is-enabled\": \"true\" },
+                                        { \"id\":\"fw_udp4\", \"is-enabled\": \"true\" }, 
+                                        {\"id\": \"fw_udp5\", \"is-enabled\":\"true\" }]}}"
+                          }
+                      }
+             }
+
+
 ConfigModify Response
 ^^^^^^^^^^^^^^^^^^^^^
 
@@ -1906,11 +1940,21 @@ This command can be applied to any VNF type. The only restriction is that the VN
 +------------------------------+---------------------------------------------------+
 |     **Action-identifiers**   |     Vnf-id                                        |
 +------------------------------+---------------------------------------------------+
-|     **Payload Parameters**   |     None                                          |
+|     **Payload Parameters**   |     See below                                     |
 +------------------------------+---------------------------------------------------+
 |     **Revision History**     |     Unchanged in this release.                    |
 +------------------------------+---------------------------------------------------+
 
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
+|     **Parameter**    |     **Description**                                                                                                                                       |     **Required?**   |     **Example**                  |
++======================+===========================================================================================================================================================+=====================+==================================+
+|     publish-config   |     \* If the publish\-config field is set to Y in the payload, then always write the running configuration to file                                       |     Yes             |     "publish-config": "<Y\|N>"   |
+|                      |                                                                                                                                                           |                     |                                  |
+|                      |     \* If the publish\-config field is set to N in the payload, then running configuration is not written to the file                                     |                     |                                  |
+|                      |                                                                                                                                                           |                     |                                  |
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
+
+
 Unlock
 ------