docs/offeredapis.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3
   4 Offered APIs
   5 =================
   6
   7 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   8 | Entity              | Method   | Path Info                                             | Description                                                                                                                                                                               |
   9 +=====================+==========+=======================================================+===========================================================================================================================================================================================+
  10 | Health Check        | GET      | /healthCheck                                          | The Health Status of the application checks the DB connection.                                                                                                                            |
  11 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  12 |                     |          |                                                       | Used by IDNS for redundancy                                                                                                                                                               |
  13 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14 |                     |          |                                                       |                                                                                                                                                                                           |
  15 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16 |                     |          |                                                       | return response entity:                                                                                                                                                                   |
  17 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18 |                     |          |                                                       | - statusCode Either 200 or 500                                                                                                                                                            |
  19 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20 |                     |          |                                                       | - detailedMsg of the result, in case of failure particular error message                                                                                                                  |
  21 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22 |                     |          |                                                       |                                                                                                                                                                                           |
  23 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24 |                     |          |                                                       | Expected:                                                                                                                                                                                 |
  25 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26 |                     |          |                                                       | {                                                                                                                                                                                         |
  27 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28 |                     |          |                                                       | “statusCode”: 200,                                                                                                                                                                        |
  29 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30 |                     |          |                                                       | “detailedMsg”: “health check succeeded”,                                                                                                                                                  |
  31 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32 |                     |          |                                                       | “date”: current date                                                                                                                                                                      |
  33 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34 |                     |          |                                                       | }                                                                                                                                                                                         |
  35 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36 |                     |          |                                                       |                                                                                                                                                                                           |
  37 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38 |                     |          |                                                       |                                                                                                                                                                                           |
  39 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40 |                     |          |                                                       |                                                                                                                                                                                           |
  41 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42 | Health Check        | GET      | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID}     | The Health Status of the application checks the DB connection                                                                                                                             |
  43 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44 |                     |          |                                                       |                                                                                                                                                                                           |
  45 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46 |                     |          |                                                       | return response entity:                                                                                                                                                                   |
  47 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48 |                     |          |                                                       | - statusCode Either 200 or 500                                                                                                                                                            |
  49 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50 |                     |          |                                                       | - detailedMsg of the result, in case of failure particular error message                                                                                                                  |
  51 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52 |                     |          |                                                       | - date string indicating the current date & time                                                                                                                                          |
  53 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54 |                     |          |                                                       |                                                                                                                                                                                           |
  55 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56 |                     |          |                                                       | Expected:                                                                                                                                                                                 |
  57 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58 |                     |          |                                                       | {                                                                                                                                                                                         |
  59 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60 |                     |          |                                                       | “statusCode”: 200,                                                                                                                                                                        |
  61 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62 |                     |          |                                                       | “detailedMsg”: “health check succeeded”,                                                                                                                                                  |
  63 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64 |                     |          |                                                       | “date”: current date                                                                                                                                                                      |
  65 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66 |                     |          |                                                       | }                                                                                                                                                                                         |
  67 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68 |                     |          |                                                       |                                                                                                                                                                                           |
  69 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70 |                     |          |                                                       |                                                                                                                                                                                           |
  71 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72 | Commit Version      | GET      | /commitInfo                                           | Displays info about the last commit of the running build                                                                                                                                  |
  73 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74 |                     |          |                                                       |                                                                                                                                                                                           |
  75 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76 |                     |          |                                                       | return response entity:                                                                                                                                                                   |
  77 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78 |                     |          |                                                       | - commitId full id of the commit                                                                                                                                                          |
  79 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80 |                     |          |                                                       | - commitMessageShort short message from the commit                                                                                                                                        |
  81 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82 |                     |          |                                                       | - commitTime time of the commit                                                                                                                                                           |
  83 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84 |                     |          |                                                       |                                                                                                                                                                                           |
  85 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86 |                     |          |                                                       | Expected:                                                                                                                                                                                 |
  87 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88 |                     |          |                                                       | {                                                                                                                                                                                         |
  89 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90 |                     |          |                                                       | “commitId”: id of the last commit                                                                                                                                                         |
  91 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92 |                     |          |                                                       | “commitMessageShort”: short message of the last commit                                                                                                                                    |
  93 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94 |                     |          |                                                       | “commitTime”: time of the last commit                                                                                                                                                     |
  95 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96 |                     |          |                                                       | }                                                                                                                                                                                         |
  97 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98 |                     |          |                                                       |                                                                                                                                                                                           |
  99 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 100 |                     |          |                                                       |                                                                                                                                                                                           |
 101 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+