From 4c520ec374468937ec2b0e911e23df4577fed90d Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Mon, 19 Nov 2018 15:53:31 +0000 Subject: [PATCH] Update OfferedAPI section Add links to listener swagger Add swagger for healthCheck Change-Id: I46d580e6d589686441ac899ebfa3c397d3464f62 Issue-ID: EXTAPI-163 Signed-off-by: Eric Debeau --- docs/offeredapis/offeredapis.rst | 3 +- docs/offeredapis/swaggers/healthCheck_3_0_0.json | 61 ++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 docs/offeredapis/swaggers/healthCheck_3_0_0.json diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index ce87e03..5b3c4ae 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -87,7 +87,8 @@ API Table "serviceCatalog", ":download:`link `", ":download:`link `", ":download:`link `", "coming", "coming", "coming" "serviceInventory", ":download:`link `", ":download:`link `", ":download:`link `", "coming", "coming", "coming" "serviceOrder", ":download:`link `", ":download:`link `", ":download:`link `", "coming", ":download:`link `", "coming" - + "listener", ":download:`link `", ":download:`link `", ":download:`link `", "coming", "coming", "coming" + "healthCheck", ":download:`link `", "coming", "coming", "coming", "coming", "coming" *************** API Description diff --git a/docs/offeredapis/swaggers/healthCheck_3_0_0.json b/docs/offeredapis/swaggers/healthCheck_3_0_0.json new file mode 100644 index 0000000..8092cb0 --- /dev/null +++ b/docs/offeredapis/swaggers/healthCheck_3_0_0.json @@ -0,0 +1,61 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "This is the ONAP NBI HealthCheck API", + "version" : "3.0.0", + "title" : "NBI HealthCheck API", + "contact" : { + "email" : "romain.gimbert@orange.com" + }, + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "host" : "serverRoot", + "basePath" : "/nbi/api/v3", + "schemes" : [ "http" ], + "produces": [ + "application/json;charset=utf-8" + ], + "paths" : { + "/status" : { + "get" : { + "summary" : "Displays health status for the NBI component", + "operationId" : "commitInfo", + "description" : "Displays health status for the NBI component", + "responses": { + "200": { + "description": "Service OK", + "schema": { + "$ref": "#/definitions/Status" + } + }, + "503" : { + "description" : "Service Unavailable" + } + } + } + } + }, + "definitions": { + "Status": { + "description": "NBI Status", + "type": "object", + "properties": { + "name": { + "description": "name of NBI component", + "type": "string" + }, + "status": { + "description": "status of NBI component", + "type": "string" + }, + "version": { + "description": "version of NBI component", + "type": "string" + } + } + } + } +} -- 2.16.6