Update OfferedAPI section

Add links to listener swagger
Add swagger for healthCheck

Change-Id: I46d580e6d589686441ac899ebfa3c397d3464f62
Issue-ID: EXTAPI-163
Signed-off-by: Eric Debeau <eric.debeau@orange.com>

diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index ce87e03..5b3c4ae 100644 (file)
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -87,7 +87,8 @@ API Table
    "serviceCatalog", ":download:`link <swaggers/serviceCatalog_3_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "coming", "coming", "coming"
    "serviceInventory", ":download:`link <swaggers/serviceInventory_3_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "coming", "coming", "coming"
    "serviceOrder", ":download:`link <swaggers/serviceOrder_3_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "coming", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming"
-
+   "listener", ":download:`link <swaggers/listener-1_0_0.json>`", ":download:`link <listener/documentation.html>`", ":download:`link <listener/apiListener.plantuml>`", "coming", "coming", "coming"
+   "healthCheck", ":download:`link <swaggers/healthCheck_3_0_0.json>`", "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 (file)
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"
+        }      
+      }
+    }
+  }
+}