summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/api_status/swagger.yaml
diff options
context:
space:
mode:
authoraosull01 <adrian.osullivan@huawei.com>2020-01-14 07:38:31 +0000
committeraosull01 <adrian.osullivan@huawei.com>2020-01-14 07:38:31 +0000
commit2ebe57db71ea6515ad86cf9264864278143e4fcd (patch)
tree2786e153a19a55442067d655dd06c1e93fd517bd /docs/offeredapis/api_status/swagger.yaml
parent74474544e4e3013c582ca5579a0088c40dacc0e5 (diff)
update swagger based on spectral scans
Issue-ID: EXTAPI-378 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I3f9b27f67e19f25d92a1383a398a817ab51e8358
Diffstat (limited to 'docs/offeredapis/api_status/swagger.yaml')
-rw-r--r--docs/offeredapis/api_status/swagger.yaml21
1 files changed, 12 insertions, 9 deletions
diff --git a/docs/offeredapis/api_status/swagger.yaml b/docs/offeredapis/api_status/swagger.yaml
index 6d21240..a5c156f 100644
--- a/docs/offeredapis/api_status/swagger.yaml
+++ b/docs/offeredapis/api_status/swagger.yaml
@@ -16,7 +16,7 @@ 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"
+ version: "4.1.0"
title: "Status API"
contact:
name: "ONAP"
@@ -40,6 +40,9 @@ tags:
- name: "Status"
description: ""
paths:
+ x-interface:
+ api-version: "4.1.0"
+ last-mod-release: "Frankfurt"
/status:
get:
tags:
@@ -66,19 +69,19 @@ paths:
type: "boolean"
default: false
responses:
- 200:
+ "200":
description: "Ok"
schema:
$ref: "#/definitions/Status"
definitions:
StatusValue:
- description: ""
+ description: "Status Value"
type: "string"
enum:
- "ok"
- "ko"
ComponentsName:
- description: ""
+ description: "Components Name"
type: "string"
enum:
- "sdc connectivity"
@@ -86,12 +89,12 @@ definitions:
- "aai connectivity"
- "dmaap connectivity"
ApplicationName:
- description: ""
+ description: "Application Name"
type: "string"
enum:
- "nbi"
ErrorDetail:
- description: ""
+ description: "Error code, inforURL, description and message"
required:
- "code"
- "message"
@@ -111,7 +114,7 @@ definitions:
description: ""
type: "string"
Error:
- description: ""
+ description: "Error code and message"
required:
- "code"
- "message"
@@ -135,7 +138,7 @@ definitions:
items:
$ref: "#/definitions/ErrorDetail"
Component:
- description: ""
+ description: "Component"
required:
- "name"
- "status"
@@ -146,7 +149,7 @@ definitions:
status:
$ref: "#/definitions/StatusValue"
Status:
- description: ""
+ description: "Status"
required:
- "name"
- "status"