Refresh offered-APIs doc

- Redo table frames
- Cross-ref from administration.rst

Issue-ID: VID-370
Change-Id: I97198d1d7cdbe6452834fcde0c4cfe1f7119513c
Signed-off-by: Ittay Stern <ittay.stern@att.com>

diff --git a/docs/administration.rst b/docs/administration.rst
index 1eec480..c3d571c 100644 (file)
--- a/docs/administration.rst
+++ b/docs/administration.rst
@@ -13,9 +13,11 @@ Actions
 - |  **Populate VID Project/Owning entity/Line of Business/Platform drop downs** 
   |  VID administrator has to populate this drop downs with at least one option each. This gets done easily by a POST request. In the following example we add a "Demonstration" option to the Line of Business drop down:
   |
-  |  ``curl -X POST 'http://vid.api.simpledemo.onap.org:8080/vid/maintenance/category_parameter/lineOfBusiness' -H 'Accept-Encoding: gzip, deflate' -H 'Content-Type:application/json' -d '{"options":["Demonstration"]}'``
+  |  ``curl -X POST 'http://vid.api.simpledemo.onap.org:8080/vid/maintenance/category_parameter/lineOfBusiness' -H 'Content-Type:application/json' -d '{"options":["Demonstration"]}'``
   |
   |  (Replace lineOfBusiness with: platform, project, owningEntity - in order to add Demonstration to all other drop downs as well)
+  |
+  |  See :ref:`vid-maintenance-apis`.
 
 - |  **Set change management workflows support for a VNF** 
   |  VID administrator has to set explicity the available workflows by VNF UUID and invariantUUID. This gets done easily by a POST request. In the following example we set both Scale out and In software update support for UUID X-X-X-X and invariantUUID Y-Y-Y-Y:

diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index c39e2c2..ad65740 100644 (file)
--- a/docs/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -4,98 +4,83 @@
 Offered APIs
 =================
 
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Entity              | Method   | Path Info                                             | Description                                                                                                                                                                               |
-+=====================+==========+=======================================================+===========================================================================================================================================================================================+
-| Health Check        | GET      | /healthCheck                                          | The Health Status of the application checks the DB connection.                                                                                                                            |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | Used by IDNS for redundancy                                                                                                                                                               |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | return response entity:                                                                                                                                                                   |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | - statusCode Either 200 or 500                                                                                                                                                            |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | - detailedMsg of the result, in case of failure particular error message                                                                                                                  |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | Expected:                                                                                                                                                                                 |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | {                                                                                                                                                                                         |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “statusCode”: 200,                                                                                                                                                                        |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “detailedMsg”: “health check succeeded”,                                                                                                                                                  |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “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                                                                                                                                                     |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | }                                                                                                                                                                                         |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
++---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
+| Entity              | Method   | Path Info                                             | Description                                                                              |
++=====================+==========+=======================================================+==========================================================================================+
+| Health Check        | GET      | /healthCheck                                          | The Health Status of the application checks the DB connection.                           |
++---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
+|                     |          |                                                       | | Used by IDNS for redundancy                                                            |
+|                     |          |                                                       | |                                                                                        |
+|                     |          |                                                       | | return response entity:                                                                |
+|                     |          |                                                       | | - statusCode Either 200 or 500                                                         |
+|                     |          |                                                       | | - detailedMsg of the result, in case of failure particular error message               |
+|                     |          |                                                       | |                                                                                        |
+|                     |          |                                                       | | Expected:                                                                              |
+|                     |          |                                                       |                                                                                          |
+|                     |          |                                                       | .. code-block:: javascript                                                               |
+|                     |          |                                                       |                                                                                          |
+|                     |          |                                                       |     {                                                                                    |
+|                     |          |                                                       |       "statusCode": 200,                                                                 |
+|                     |          |                                                       |       "detailedMsg": "health check succeeded",                                           |
+|                     |          |                                                       |       "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:                                                                              |
+|                     |          |                                                       |                                                                                          |
+|                     |          |                                                       | .. code-block:: javascript                                                               |
+|                     |          |                                                       |                                                                                          |
+|                     |          |                                                       |    {                                                                                     |
+|                     |          |                                                       |      "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:                                                                              |
+|                     |          |                                                       |                                                                                          |
+|                     |          |                                                       | .. code-block:: javascript                                                               |
+|                     |          |                                                       |                                                                                          |
+|                     |          |                                                       |    {                                                                                     |
+|                     |          |                                                       |      "commitId": id of the last commit                                                   |
+|                     |          |                                                       |      "commitMessageShort": short message of the last commit                              |
+|                     |          |                                                       |      "commitTime": time of the last commit                                               |
+|                     |          |                                                       |    }                                                                                     |
+|                     |          |                                                       |                                                                                          |
++---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
+
+
+.. _vid-maintenance-apis:
+
+Maintenance APIs
+------------------
+
++---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
+| Maintenance:        | POST     | /maintenance/category_parameter/{categoryName}        | Populate VID Project/Owning entity/Line of Business/Platform drop downs                  |
+| Category Parameters |          |                                                       |                                                                                          |
++---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
+|                     |          |                                                       | ``{categoryName}`` is one of lineOfBusiness, platform, project, owningEntity.            |
+|                     |          |                                                       |                                                                                          |
+|                     |          |                                                       | POST body:                                                                               |
+|                     |          |                                                       |                                                                                          |
+|                     |          |                                                       | .. code-block:: javascript                                                               |
+|                     |          |                                                       |                                                                                          |
+|                     |          |                                                       |    {                                                                                     |
+|                     |          |                                                       |      "options": [ <list of strings> ]                                                    |
+|                     |          |                                                       |    }                                                                                     |
+|                     |          |                                                       |                                                                                          |
++---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+