aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis.rst
diff options
context:
space:
mode:
authorIttay Stern <ittay.stern@att.com>2019-03-24 15:46:24 +0200
committerIttay Stern <ittay.stern@att.com>2019-03-25 12:25:32 +0200
commit24f220c4737b5af15698d79a49f605b989bfacfd (patch)
tree27bb1dda0256f1d3217d439ca54520fd50ad1f76 /docs/offeredapis.rst
parent5033a22e5f8450e5837ce460079d7f1694b79707 (diff)
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>
Diffstat (limited to 'docs/offeredapis.rst')
-rw-r--r--docs/offeredapis.rst175
1 files changed, 80 insertions, 95 deletions
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index c39e2c27c..ad6574039 100644
--- 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> ] |
+| | | | } |
+| | | | |
++---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+