Docs update

Change-Id: I4a71812cdde1064de54df51add9d6b965d8eca77
Issue-ID: VID-254
Signed-off-by: Sonsino, Ofir (os0695) <os0695@intl.att.com>

diff --git a/docs/installation.rst b/docs/installation.rst
index 040baf2..e8e5af7 100644 (file)
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -17,7 +17,7 @@ Please follow the instructions given below, for installing VID using a Docker im
 
   docker pull mariadb:10
   docker login -u docker -p docker nexus3.onap.org:10001
-  docker pull nexus3.onap.org:10001/onap/vid:3.1.0
+  docker pull nexus3.onap.org:10001/onap/vid:3.2.0
 
 2. Install by running following command (Use the path for the lf_config folder under the VID git repository as CONFIG_PATH)
 
@@ -27,7 +27,7 @@ Please follow the instructions given below, for installing VID using a Docker im
    docker run --name vid-mariadb -e MYSQL_DATABASE=vid_openecomp_epsdk -e MYSQL_USER=vidadmin -e MYSQL_PASSWORD=YOUR_PASSWORD -e MYSQL_ROOT_PASSWORD=ROOT_PASSWORD -v CONFIG_PATH/vid-my.cnf:/etc/mysql/my.cnf -v /var/lib/mysql -d mariadb:10
    
    #start VID server
-   docker run -e VID_MYSQL_DBNAME=vid_openecomp_epsdk -e VID_MYSQL_PASS=YOUR_PASSWORD --name vid-server -p 8080:8080 --link vid-mariadb:vid-mariadb-docker-instance -d nexus3.onap.org:10001/onap/vid:3.1.0
+   docker run -e VID_MYSQL_DBNAME=vid_openecomp_epsdk -e VID_MYSQL_PASS=YOUR_PASSWORD --name vid-server -p 8080:8080 --link vid-mariadb:vid-mariadb-docker-instance -d nexus3.onap.org:10001/onap/vid:3.2.0
 
 Or use docker-compose:
 

diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index e8f7ef7..c39e2c2 100644 (file)
--- a/docs/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -17,7 +17,7 @@ Offered APIs
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |                     |          |                                                       | - statusCode Either 200 or 500                                                                                                                                                            |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | - The message contains additional detail in the case of an error, and is empty in the case of success.                                                                                    |
+|                     |          |                                                       | - detailedMsg of the result, in case of failure particular error message                                                                                                                  |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |                     |          |                                                       |                                                                                                                                                                                           |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -25,13 +25,77 @@ Offered APIs
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |                     |          |                                                       | {                                                                                                                                                                                         |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “statusCode”:200,                                                                                                                                                                         |
+|                     |          |                                                       | “statusCode”: 200,                                                                                                                                                                        |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “message”:“health check succeeded”,                                                                                                                                                       |
+|                     |          |                                                       | “detailedMsg”: “health check succeeded”,                                                                                                                                                  |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “date”:null                                                                                                                                                                               |
+|                     |          |                                                       | “date”: current date                                                                                                                                                                      |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |                     |          |                                                       | }                                                                                                                                                                                         |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |                     |          |                                                       |                                                                                                                                                                                           |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Health Check        | GET      | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID}     | The Health Status of the application checks the DB connection                                                                                                                             |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | return response entity:                                                                                                                                                                   |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | - statusCode Either 200 or 500                                                                                                                                                            |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | - detailedMsg of the result, in case of failure particular error message                                                                                                                  |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | - date string indicating the current date & time                                                                                                                                          |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | Expected:                                                                                                                                                                                 |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | {                                                                                                                                                                                         |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | “statusCode”: 200,                                                                                                                                                                        |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | “detailedMsg”: “health check succeeded”,                                                                                                                                                  |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | “date”: current date                                                                                                                                                                      |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | }                                                                                                                                                                                         |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Commit Version      | GET      | /commitInfo                                           | Displays info about the last commit of the running build                                                                                                                                  |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | return response entity:                                                                                                                                                                   |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | - commitId full id of the commit                                                                                                                                                          |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | - commitMessageShort short message from the commit                                                                                                                                        |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | - commitTime time of the commit                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | Expected:                                                                                                                                                                                 |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | {                                                                                                                                                                                         |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | “commitId”: id of the last commit                                                                                                                                                         |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | “commitMessageShort”: short message of the last commit                                                                                                                                    |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | “commitTime”: time of the last commit                                                                                                                                                     |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       | }                                                                                                                                                                                         |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                     |          |                                                       |                                                                                                                                                                                           |
++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index d267e4d..d1e39eb 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -3,7 +3,7 @@
 VID Release Notes
 =================
 
-Version: 3.1.0
+Version: 3.2.0
 --------------
 
 :Release Date: 2018-11-15