docs/offeredapis/swaggers/healthCheck_3_0_0.json

   1 {
   2   "swagger" : "2.0",
   3   "info" : {
   4     "description" : "This is the ONAP NBI HealthCheck API",
   5     "version" : "3.0.0",
   6     "title" : "NBI HealthCheck API",
   7     "contact" : {
   8       "email" : "romain.gimbert@orange.com"
   9     },
  10     "license" : {
  11       "name" : "Apache 2.0",
  12       "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
  13     }
  14   },
  15   "host" : "serverRoot",
  16   "basePath" : "/nbi/api/v3",
  17   "schemes" : [ "http" ],
  18   "produces": [
  19     "application/json;charset=utf-8"
  20   ],
  21   "paths" : {
  22     "/status" : {
  23       "get" : {
  24         "summary" : "Displays health status for the NBI component",
  25         "operationId" : "commitInfo",
  26         "description" : "Displays health status for the NBI component",
  27         "responses": {
  28           "200": {
  29             "description": "Service OK",
  30             "schema": {
  31               "$ref": "#/definitions/Status"
  32             }
  33           },
  34           "503" : {
  35             "description" : "Service Unavailable"
  36           }
  37         }
  38       }
  39     }
  40   },
  41   "definitions": {
  42     "Status": {
  43       "description": "NBI Status",
  44       "type": "object",
  45       "properties": {
  46         "name": {
  47           "description": "name of NBI component",
  48               "type": "string"
  49         },
  50         "status": {
  51           "description": "status of NBI component",
  52               "type": "string"
  53         },
  54         "version": {
  55           "description": "version of NBI component",
  56               "type": "string"
  57         }
  58       }
  59     }
  60   }
  61 }