docs/offeredapis/swagger/status.json

   1
   2     {
   3     "swagger": "2.0",
   4     "info": {
   5     "description": "Provides a healthcheck to verify that the NBI component is running as expected as a standalone application or that the NBI can communicate with other onap modules that it needs.\n\n",
   6     "version": "4.1.0",
   7     "title": "Status API",
   8     "contact": {
   9       "name": "ONAP",
  10       "url": "https://onap.readthedocs.io",
  11       "email": "onap-discuss@lists.onap.org"
  12     },
  13     "license": {
  14       "name": "Apache 2.0",
  15       "url": "http://www.apache.org/licenses/LICENSE-2.0"
  16     },
  17     "x-planned-retirement-date": "205001",
  18     "x-component": "NBI",
  19     "x-logo": {
  20     "url": "/redoc/logo.png",
  21     "backgroundColor": "#FFFFFF"
  22     }
  23     },
  24
  25       "host": "nbi.api.simpledemo.onap.org:30274",
  26       "basePath":"/nbi/api/v4",
  27       "schemes": [
  28       "https"
  29       ],
  30     "produces": [
  31     "application/json;charset=utf-8"
  32     ],
  33     "tags": [
  34
  35       {
  36       "name": "Status",
  37       "description": ""
  38       }
  39     ],
  40     "paths": {
  41     "x-interface": {
  42     "api-version": "4.1.0",
  43     "last-mod-release": "Frankfurt"
  44     },
  45       "/status": {
  46     "get": {
  47     "tags": [
  48     "Status"
  49     ],
  50         "produces": [
  51            "application/json;charset=utf-8"
  52       ],
  53     "operationId": "status_Find",
  54     "summary": "This API retieves the status of the NBI application as a healthcheck",
  55     "description": "* Default\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"ok\",\n    \"version\": \"v3\"\n}\n```\n\n* Optional\n\n```\n?fullStatus=true\n```\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"ok\",\n    \"version\": \"v3\",\n    \"components\": [\n        {\n            \"name\": \"sdc connectivity\",\n            \"status\": \"ko\"\n        },\n        {\n            \"name\": \"so connectivity\",\n            \"status\": \"ok\"\n        },\n        {\n            \"name\": \"aai connectivity\",\n            \"status\": \"ok\"\n        },\n        {\n            \"name\": \"dmaap connectivity\",\n            \"status\": \"ok\"\n        }\n    ]\n}\n```",
  56     "deprecated": false,
  57
  58       "parameters": [
  59
  60     {
  61     "name": "fullStatus",
  62     "required": false,
  63     "in": "query",
  64     "description": "",
  65
  66     "type": "boolean",
  67
  68         "default": false
  69     }
  70       ],
  71     "responses": {
  72     "200": {
  73     "description": "Ok",
  74     "schema": {
  75     "$ref": "#/definitions/Status"
  76     }
  77
  78     }
  79     }
  80     }
  81       }
  82     },
  83     "definitions": {
  84
  85     "StatusValue": {
  86     "description": "Status Value",
  87
  88       "type": "string",
  89       "enum": [
  90         "ok",
  91         "ko"]
  92
  93     },
  94     "ComponentsName": {
  95     "description": "Components Name",
  96
  97       "type": "string",
  98       "enum": [
  99         "sdc connectivity",
 100         "so connectivity",
 101         "aai connectivity",
 102         "dmaap connectivity"]
 103
 104     },
 105     "ApplicationName": {
 106     "description": "Application Name",
 107
 108       "type": "string",
 109       "enum": [
 110         "nbi"]
 111
 112     },
 113
 114     "ErrorDetail": {
 115     "description": "Error code, infoURL, description and message",
 116
 117
 118     "required": [
 119
 120       "code",
 121       "message"
 122     ],
 123     "type": "object",
 124     "properties": {
 125     "code": {
 126     "description": "",
 127     "type": "integer",
 128     "format": "int32"
 129     },
 130     "message": {
 131     "description": "",
 132     "type": "string"
 133     },
 134     "description": {
 135     "description": "",
 136     "type": "string"
 137     },
 138     "infoURL": {
 139     "description": "",
 140     "type": "string"
 141     }
 142     }
 143
 144     },
 145
 146     "Error": {
 147     "description": "Error code and message",
 148
 149
 150     "required": [
 151
 152       "code",
 153       "message"
 154     ],
 155     "type": "object",
 156     "properties": {
 157     "code": {
 158     "description": "",
 159     "type": "integer",
 160     "format": "int32"
 161     },
 162     "message": {
 163     "description": "",
 164     "type": "string"
 165     },
 166     "description": {
 167     "description": "",
 168     "type": "string"
 169     },
 170     "infoURL": {
 171     "description": "",
 172     "type": "string"
 173     },
 174     "details": {
 175
 176     "type": "array",
 177     "items": {
 178     "$ref": "#/definitions/ErrorDetail"
 179     }
 180     }
 181     }
 182
 183     },
 184
 185     "Component": {
 186     "description": "Component",
 187
 188
 189     "required": [
 190
 191       "name",
 192       "status"
 193     ],
 194     "type": "object",
 195     "properties": {
 196     "name": {
 197
 198     "$ref": "#/definitions/ComponentsName"
 199     },
 200     "status": {
 201
 202     "$ref": "#/definitions/StatusValue"
 203     }
 204     }
 205
 206     },
 207
 208     "Status": {
 209     "description": "Status",
 210
 211
 212     "required": [
 213
 214       "name",
 215       "status",
 216       "version",
 217       "components"
 218     ],
 219     "type": "object",
 220     "properties": {
 221     "name": {
 222
 223     "$ref": "#/definitions/ApplicationName"
 224     },
 225     "status": {
 226
 227     "$ref": "#/definitions/StatusValue"
 228     },
 229     "version": {
 230     "description": "",
 231     "type": "string"
 232     },
 233     "components": {
 234
 235     "type": "array",
 236     "items": {
 237     "$ref": "#/definitions/Component"
 238     }
 239     }
 240     }
 241
 242     }
 243     }
 244     }
 245