Update OfferedAPI section

[externalapi/nbi.git] / docs / offeredapis / swaggers / healthCheck_3_0_0.json

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"
+        }      
+      }
+    }
+  }
+}