diff options
| author |   Ofir Sonsino <ofir.sonsino@intl.att.com> | 2018-11-06 09:33:48 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2018-11-06 09:33:48 +0000 |
| commit | 9daaecd1a2450fe2bae247ae320b4e7c6d7ceee5 (patch) | |
| tree | 71f9de5d0d6240c0beb1f769671e30adf26f15f6 /docs/offeredapis.rst | |
| parent | 5a7cdb624c0abe6f2b7e80bcbbaa740c4ee35e39 (diff) | |
| parent | 56f2ad282e7a8d316b92878ae151767fea847265 (diff) | |
Merge "HealthCheckController/test refactor"
Diffstat (limited to 'docs/offeredapis.rst')
| -rw-r--r-- | docs/offeredapis.rst | 46 |
1 files changed, 39 insertions, 7 deletions
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index 4408bf6f0..4ee12612d 100644 --- 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,11 +25,11 @@ Offered APIs +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | { | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | “statusCode”:200, | +| | | | “statusCode”: 200, | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | “message”:“health check succeeded”, | +| | | | “detailedMsg”: “health check succeeded”, | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | “date”:null | +| | | | “date”: current date | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | } | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,7 +47,7 @@ Offered APIs +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | - statusCode Either 200 or 500 | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | - 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 | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | - date string indicating the current date & time | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,9 +57,9 @@ Offered APIs +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | { | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | “statusCode”:200, | +| | | | “statusCode”: 200, | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | “message”:“health check succeeded”, | +| | | | “detailedMsg”: “health check succeeded”, | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | “date”: current date | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,6 +69,38 @@ Offered APIs +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | } | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Change management | GET | change-management/workflow {vnfStringsList} | Get Workflow details for the VNFs list | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | |