diff options
| author |   aosull01 <adrian.osullivan@huawei.com> | 2020-02-28 17:58:55 +0000 |
|---|---|---|
| committer | aosull01 <adrian.osullivan@huawei.com> | 2020-02-28 18:15:34 +0000 |
| commit | ca20793652dc0df6c25cdde9e2bbe007c0efebbe (patch) | |
| tree | 34cb17940b6245170cbb287689f346916186f2a5 /docs/offeredapis/api_status/swagger.json | |
| parent | d72257cd1b886b2fbc0e01036542a763640b0b5f (diff) | |
Add index html and update remaining swagger for NBI
Issue-ID: EXTAPI-402
Signed-off-by: aosull01 <adrian.osullivan@huawei.com>
Change-Id: I5746fd31f14c106bb85983af987ef0e71910e20d
Diffstat (limited to 'docs/offeredapis/api_status/swagger.json')
| -rw-r--r-- | docs/offeredapis/api_status/swagger.json | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/offeredapis/api_status/swagger.json b/docs/offeredapis/api_status/swagger.json index 9d49fd0..70e6a04 100644 --- a/docs/offeredapis/api_status/swagger.json +++ b/docs/offeredapis/api_status/swagger.json @@ -2,7 +2,7 @@ { "swagger": "2.0", "info": { - "description": "Provides a healthcheck to verify that the NBI component is running fine as a standalone application or can also communicate with other onap modules.\n\n", + "description": "Provides a healthcheck to verify that the NBI component is running as expected as a standalone application or that the NBI can communicate with other onap modules that it needs.\n\n", "version": "4.1.0", "title": "Status API", "contact": { @@ -51,7 +51,7 @@ "application/json;charset=utf-8" ], "operationId": "status_Find", - "summary": "retrieve application status", + "summary": "This API retieves the status of the NBI application as a healthcheck", "description": "* Default\n\n```\n{\n \"name\": \"nbi\",\n \"status\": \"ok\",\n \"version\": \"v3\"\n}\n```\n\n* Optional\n\n```\n?fullStatus=true\n```\n\n```\n{\n \"name\": \"nbi\",\n \"status\": \"ok\",\n \"version\": \"v3\",\n \"components\": [\n {\n \"name\": \"sdc connectivity\",\n \"status\": \"ko\"\n },\n {\n \"name\": \"so connectivity\",\n \"status\": \"ok\"\n },\n {\n \"name\": \"aai connectivity\",\n \"status\": \"ok\"\n },\n {\n \"name\": \"dmaap connectivity\",\n \"status\": \"ok\"\n }\n ]\n}\n```", "deprecated": false, |