docs/offeredapis/api_status/swagger.yaml

   1 swagger: "2.0"
   2 info:
   3   description: "Provides a healthcheck to verify that the NBI component is running\
   4     \ fine as a standalone application or can also communicate with other onap modules.\n\
   5     \n"
   6   version: "4.0.0_inProgress"
   7   title: "API Status"
   8   x-logo:
   9     url: "/redoc/logo.png"
  10     backgroundColor: "#FFFFFF"
  11 host: "localhost:8080"
  12 basePath: "/nbi/api/v4"
  13 schemes:
  14 - "http"
  15 produces:
  16 - "application/json;charset=utf-8"
  17 tags:
  18 - name: "Status"
  19   description: ""
  20 paths:
  21   /status:
  22     get:
  23       tags:
  24       - "Status"
  25       produces:
  26       - "application/json;charset=utf-8"
  27       operationId: "statusFind"
  28       summary: "retrieve application status"
  29       description: "* Default\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"\
  30         ok\",\n    \"version\": \"v3\"\n}\n```\n\n* Optional\n\n```\n?fullStatus=true\n\
  31         ```\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"ok\",\n    \"version\"\
  32         : \"v3\",\n    \"components\": [\n        {\n            \"name\": \"sdc connectivity\"\
  33         ,\n            \"status\": \"ko\"\n        },\n        {\n            \"name\"\
  34         : \"so connectivity\",\n            \"status\": \"ok\"\n        },\n     \
  35         \   {\n            \"name\": \"aai connectivity\",\n            \"status\"\
  36         : \"ok\"\n        },\n        {\n            \"name\": \"dmaap connectivity\"\
  37         ,\n            \"status\": \"ok\"\n        }\n    ]\n}\n```"
  38       deprecated: false
  39       parameters:
  40       - name: "fullStatus"
  41         required: false
  42         in: "query"
  43         description: ""
  44         type: "boolean"
  45         default: false
  46       responses:
  47         200:
  48           description: "Ok"
  49           schema:
  50             $ref: "#/definitions/Status"
  51 definitions:
  52   StatusValue:
  53     description: ""
  54     type: "string"
  55     enum:
  56     - "ok"
  57     - "ko"
  58   ComponentsName:
  59     description: ""
  60     type: "string"
  61     enum:
  62     - "sdc connectivity"
  63     - "so connectivity"
  64     - "aai connectivity"
  65     - "dmaap connectivity"
  66   ApplicationName:
  67     description: ""
  68     type: "string"
  69     enum:
  70     - "nbi"
  71   ErrorDetail:
  72     description: ""
  73     required:
  74     - "code"
  75     - "message"
  76     type: "object"
  77     properties:
  78       code:
  79         description: ""
  80         type: "integer"
  81         format: "int32"
  82       message:
  83         description: ""
  84         type: "string"
  85       description:
  86         description: ""
  87         type: "string"
  88       infoURL:
  89         description: ""
  90         type: "string"
  91   Error:
  92     description: ""
  93     required:
  94     - "code"
  95     - "message"
  96     type: "object"
  97     properties:
  98       code:
  99         description: ""
 100         type: "integer"
 101         format: "int32"
 102       message:
 103         description: ""
 104         type: "string"
 105       description:
 106         description: ""
 107         type: "string"
 108       infoURL:
 109         description: ""
 110         type: "string"
 111       details:
 112         type: "array"
 113         items:
 114           $ref: "#/definitions/ErrorDetail"
 115   Component:
 116     description: ""
 117     required:
 118     - "name"
 119     - "status"
 120     type: "object"
 121     properties:
 122       name:
 123         $ref: "#/definitions/ComponentsName"
 124       status:
 125         $ref: "#/definitions/StatusValue"
 126   Status:
 127     description: ""
 128     required:
 129     - "name"
 130     - "status"
 131     - "version"
 132     - "components"
 133     type: "object"
 134     properties:
 135       name:
 136         $ref: "#/definitions/ApplicationName"
 137       status:
 138         $ref: "#/definitions/StatusValue"
 139       version:
 140         description: ""
 141         type: "string"
 142       components:
 143         type: "array"
 144         items:
 145           $ref: "#/definitions/Component"