docs/offeredapis/api_status/swagger.json

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