aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/swaggers/healthCheck_3_0_0.json
blob: 8092cb06cead5a0c595b98f6abcd7ffe8aa748fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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"
        }      
      }
    }
  }
}