aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/api_status/swagger.json
diff options
context:
space:
mode:
authoraosull01 <adrian.osullivan@huawei.com>2020-01-07 12:28:11 +0000
committeraosull01 <adrian.osullivan@huawei.com>2020-01-07 12:28:11 +0000
commitdf23184a2288013d954392d3f5e59787aeca41bc (patch)
treee52939d1d428de53f87b1f5c36d197f5dda6e679 /docs/offeredapis/api_status/swagger.json
parentc1ae66b947edefe90ffb9c788db1ee75779b0624 (diff)
Update other swaggers as per guidelines
Issue-ID: EXTAPI-357 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I906f81722074c9a679ac6048e544e884646ed760
Diffstat (limited to 'docs/offeredapis/api_status/swagger.json')
-rw-r--r--docs/offeredapis/api_status/swagger.json19
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/offeredapis/api_status/swagger.json b/docs/offeredapis/api_status/swagger.json
index aaeeeb5..344b684 100644
--- a/docs/offeredapis/api_status/swagger.json
+++ b/docs/offeredapis/api_status/swagger.json
@@ -4,15 +4,26 @@
"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",
"version": "4.0.1",
- "title": "API Status",
+ "title": "Status API",
+ "contact": {
+ "name": "ONAP",
+ "url": "https://onap.readthedocs.io",
+ "email": "onap-discuss@lists.onap.org"
+ },
+ "license": {
+ "name": "Apache 2.0",
+ "url": "http://www.apache.org/licenses/LICENSE-2.0"
+ },
+ "x-planned-retirement-date": "205001",
+ "x-component": "NBI",
"x-logo": {
"url": "/redoc/logo.png",
"backgroundColor": "#FFFFFF"
}
},
- "host": "localhost:8080",
- "basePath": "/nbi/api/v4",
+ "host": "serverRoot:30274",
+ "basePath":"/nbi/api/v4",
"schemes": [
"http"
],
@@ -35,7 +46,7 @@
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "statusFind",
+ "operationId": "status_Find",
"summary": "retrieve application status",
"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,