diff options
Diffstat (limited to 'docs/APPC API Guide/APPC API Guide.rst')
| -rw-r--r-- | docs/APPC API Guide/APPC API Guide.rst | 55 |
1 files changed, 16 insertions, 39 deletions
diff --git a/docs/APPC API Guide/APPC API Guide.rst b/docs/APPC API Guide/APPC API Guide.rst index e00dc50ce..6938d1511 100644 --- a/docs/APPC API Guide/APPC API Guide.rst +++ b/docs/APPC API Guide/APPC API Guide.rst @@ -1,3 +1,4 @@ +============================================ ONAP Application Controller (APPC) API Guide ============================================ @@ -33,28 +34,6 @@ Target Audience This document is intended for an advanced technical audience, such as the engineers or architects who need to use this guide to develop an interfacing application. The guide assumes a knowledge of the Open Network Automation Platform (ONAP) components and features, and familiarity with JSON notation. -Conventions ------------ - -+--------------+------------------------------------------------------------------------------------------+ -| Convention | Description | -| | | -+==============+==========================================================================================+ -|``Monospace`` | This font indicates sample codes, screenshots, or elements. For example:: | -| | | -| | "contact": { | -| | "contactType": "USER", | -| | "source": "app1", | -| | } | -| | | -+--------------+------------------------------------------------------------------------------------------+ -|*Italics* | Emphasizes a point or denotes new terms at the place where they are defined in the text. | -| | Indicates an external book title reference. | -| | | -+--------------+------------------------------------------------------------------------------------------+ - - - Life Cycle Management Commands ============================== @@ -87,21 +66,19 @@ The recommended approach for sending/receiving requests to APPC is via the messa For more details, see the APPC Client Library Guide at: - guides/appc_api_client + :ref:`appc_client_library` The client library supports both synchronous and asynchronous flows as follows. -Asynchronous Flow -^^^^^^^^^^^^^^^^^ +**Asynchronous Flow** - The APPC Client Library is called via an asynchronous API using a full command object, which is mapped to a JSON representation. - The APPC client calls the UEB/DMaaP client and sends the JSON command to a configured topic. - The APPC client pulls response messages from the configured topic. - On receiving the response for the command, APPC client runs the relevant callback method of the consumer ResponseHandler. -Synchronous Flow -^^^^^^^^^^^^^^^^ +**Synchronous Flow** - The APPC Client Library is called via a synchronous API using a full command object, which is mapped to a JSON representation. - The APPC client calls the UEB/DMaaP client and sends the JSON command to a configured topic. @@ -151,7 +128,7 @@ Generic Request Format The LCM API general request format is applicable for both POST HTTP API and for the message body received via the EUB/DMaaP bus. LCM Request -^^^^^^^^^^^ +----------- The LCM request comprises a common header and a section containing the details of the LCM action. The LCM request conforms to the following structure:: @@ -275,7 +252,7 @@ The response format is applicable for both POST HTTP API and for the message bod LCM Response -^^^^^^^^^^^^ +------------ The LCM response comprises a common header and a section containing the payload and action details. @@ -353,7 +330,7 @@ Table 3 LCM Response Fields Status Codes -^^^^^^^^^^^^ +------------ The status code is returned in the response message as the code parameter, and the description as the message parameter. @@ -462,7 +439,7 @@ The different responses are categorized as follows: Malformed Message Response -^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------- A malformed message is an invalid request based on the LCM API YANG scheme specification. APPC rejects malformed requests as implemented by ODL infrastructure level. @@ -603,7 +580,7 @@ The self-service onboarding process is done using an APPC Design GUI which inter artifacts to SDC which distributes them to all APPC instances in the same environment (e.g., production). -For more details, see the APPC Self-Service VNF Onboarding Guide (add link). +For more details, see the APPC Self-Service VNF Onboarding Guide. @@ -656,7 +633,7 @@ The Audit action does not require any payload parameters. +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+ Audit Response -^^^^^^^^^^^^^^ +-------------- The audit response returns an indication of success or failure of the audit. If a new configuration is uploaded to the APPC database, the payload contains the ‘upload\_config\_id’ and values for any records created. In addition, the configuration is sent to the ECOMP Data Router bus which may be received by an external configuration storage system. @@ -687,7 +664,7 @@ The CheckLock action does not require any payload parameters. +------------------------------+--------------------------------------------------------+ CheckLock Response -^^^^^^^^^^^^^^^^^^ +------------------ The CheckLock command returns a customized version of the LCM response. @@ -774,7 +751,7 @@ A failed Configure action returns a failure response and the specific failure me Configure Response -^^^^^^^^^^^^^^^^^^ +------------------ The Configure response returns an indication of success or failure of the request. If successful, the return payload contains the ‘upload\_config\_id’ and values for any records created. In addition, the configuration is sent to the ECOMP Data Router bus which may be received by an external configuration storage system. @@ -832,7 +809,7 @@ If successful, this request returns a success response. A failed Configure action returns a failure response and the specific failure message in the response block. ConfigModify Response -^^^^^^^^^^^^^^^^^^^^^ +--------------------- The ConfigModify response returns an indication of success or failure of the request. If successful, the return payload contains the ‘upload\_config\_id’ and values for any records created. In addition, the configuration is sent to the ECOMP Data Router bus which may be received by an external configuration storage system. @@ -1227,7 +1204,7 @@ Payload Parameters +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+ Snapshot Response -^^^^^^^^^^^^^^^^^ +----------------- The Snapshot command returns an extended version of the LCM response. @@ -1298,7 +1275,7 @@ A failed StartApplication action returns a failure response code and the specifi +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ StartApplication Response -^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------- The StartApplication response returns an indication of success or failure of the request. @@ -1358,7 +1335,7 @@ A failed StopApplication action returns a failure response code and the specific +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ StopApplication Response -^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------ The StopApplication response returns an indication of success or failure of the request. |