Updating APPC Guides with License

[appc.git] / docs / APPC Client Library Guide / APPC Client Library Guide.rst

diff --git a/docs/APPC Client Library Guide/APPC Client Library Guide.rst b/docs/APPC Client Library Guide/APPC Client Library Guide.rst
index 7de54b3..26d1305 100644 (file)
--- a/docs/APPC Client Library Guide/APPC Client Library Guide.rst
+++ b/docs/APPC Client Library Guide/APPC Client Library Guide.rst
@@ -1,3 +1,21 @@
+.. ============LICENSE_START==========================================
+.. ===================================================================
+.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+.. ===================================================================
+.. Licensed under the Creative Commons License, Attribution 4.0 Intl.  (the "License");
+.. you may not use this documentation except in compliance with the License.
+.. You may obtain a copy of the License at
+.. 
+..  https://creativecommons.org/licenses/by/4.0/
+.. 
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+.. ============LICENSE_END============================================
+.. ECOMP is a trademark and service mark of AT&T Intellectual Property.
+
 .. _appc_client_library:
 
 ==================================================
@@ -5,16 +23,6 @@ Application Controller (APPC) Client Library Guide
 ==================================================
 
 
-Revision History
-----------------
-
-+--------------+------------+---------------+--------------------------------------------------+
-| Date         | Revision   | Author        | Changes                                          |
-+--------------+------------+---------------+--------------------------------------------------+
-| 2017-08-22   | 1.0.0      | Paul Miller   | First draft                                      |
-+--------------+------------+---------------+--------------------------------------------------+
-+--------------+------------+---------------+--------------------------------------------------+
-
 Introduction
 ============
 
@@ -26,7 +34,9 @@ This document is for an advanced technical audience, which includes engineers an
 Related Documentation
 ---------------------
 
-For additional information, see the ONAP Application Controller (APPC) API Guide.
+For additional information, see
+
+        :ref:`appc_api_guide`
 
 
 Client Library Background
@@ -54,14 +64,16 @@ APP-C Client Library Flow
 
     |image0|
 
-**Asynchronous Flow**
+Asynchronous Flow
+^^^^^^^^^^^^^^^^^
 
 -  The APPC Client Library is called using an asynchronous API using a full command object, which is mapped to a JSON representation.
 -  The APPC client calls the UEB 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, the APPC client runs the relevant callback method of the consumer ResponseHandler.
 
-**Synchronous Flow**
+Synchronous Flow
+^^^^^^^^^^^^^^^^
 
 -  The APPC Client Library is called using a synchronous API using a full command object, which is mapped to a JSON representation.
 -  The APPC client calls the UEB client and sends the JSON command to a configured topic.
@@ -70,7 +82,7 @@ APP-C Client Library Flow
 
 Client Library Usage
 ====================
-      
+
 Jar Files
 ---------
 
@@ -81,7 +93,7 @@ The Java application that runs the APPC client kit uses the following jar files:
 
 The client library JAR files are located in the repository under ``com\\att\\appc\\client``.
 
-Initialization 
+Initialization
 --------------
 
 Initialize the client by calling the following method:
@@ -148,7 +160,7 @@ There may be multiple calls to the ResponseHandler for each response returned by
 LifeCycleManagerStateful Interface
 ----------------------------------
 
-Generated from the APPC Yang model, this interface defines the services and request/response requirements for the ECOMP APPC component. For example, for LCM Command Audit, the following is defined:
+Generated from the APPC Yang model, this interface defines the services and request/response requirements for the ONAP APPC component. For example, for LCM Command Audit, the following is defined:
 
 ``@RPC(name="audit", outputType=AuditOutput.class)``
 
@@ -172,8 +184,8 @@ appc-provider-lcm
 
 This defines the services and request/response requirements for the APPC component.
 
-Methods 
---------
+Methods
+-------
 
 The methods should match the actions described in the LCM API Guide. For each method: