docs/offeredapis/api_status/swagger.yaml

   1 #    Copyright (c) 2018 Orange
   2 #
   3 #    Licensed under the Apache License, Version 2.0 (the "License");
   4 #    you may not use this file except in compliance with the License.
   5 #    You may obtain a copy of the License at
   6 #
   7 #        http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #    Unless required by applicable law or agreed to in writing, software
  10 #    distributed under the License is distributed on an "AS IS" BASIS,
  11 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #    See the License for the specific language governing permissions and
  13 #    limitations under the License.swagger: "2.0"
  14 swagger: "2.0"
  15 info:
  16   description: "Provides a healthcheck to verify that the NBI component is running\
  17     \ fine as a standalone application or can also communicate with other onap modules.\n\
  18     \n"
  19   version: "4.0.1"
  20   title: "API Status"
  21   x-logo:
  22     url: "/redoc/logo.png"
  23     backgroundColor: "#FFFFFF"
  24 host: "localhost:8080"
  25 basePath: "/nbi/api/v4"
  26 schemes:
  27 - "http"
  28 produces:
  29 - "application/json;charset=utf-8"
  30 tags:
  31 - name: "Status"
  32   description: ""
  33 paths:
  34   /status:
  35     get:
  36       tags:
  37       - "Status"
  38       produces:
  39       - "application/json;charset=utf-8"
  40       operationId: "statusFind"
  41       summary: "retrieve application status"
  42       description: "* Default\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"\
  43         ok\",\n    \"version\": \"v3\"\n}\n```\n\n* Optional\n\n```\n?fullStatus=true\n\
  44         ```\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"ok\",\n    \"version\"\
  45         : \"v3\",\n    \"components\": [\n        {\n            \"name\": \"sdc connectivity\"\
  46         ,\n            \"status\": \"ko\"\n        },\n        {\n            \"name\"\
  47         : \"so connectivity\",\n            \"status\": \"ok\"\n        },\n     \
  48         \   {\n            \"name\": \"aai connectivity\",\n            \"status\"\
  49         : \"ok\"\n        },\n        {\n            \"name\": \"dmaap connectivity\"\
  50         ,\n            \"status\": \"ok\"\n        }\n    ]\n}\n```"
  51       deprecated: false
  52       parameters:
  53       - name: "fullStatus"
  54         required: false
  55         in: "query"
  56         description: ""
  57         type: "boolean"
  58         default: false
  59       responses:
  60         200:
  61           description: "Ok"
  62           schema:
  63             $ref: "#/definitions/Status"
  64 definitions:
  65   StatusValue:
  66     description: ""
  67     type: "string"
  68     enum:
  69     - "ok"
  70     - "ko"
  71   ComponentsName:
  72     description: ""
  73     type: "string"
  74     enum:
  75     - "sdc connectivity"
  76     - "so connectivity"
  77     - "aai connectivity"
  78     - "dmaap connectivity"
  79   ApplicationName:
  80     description: ""
  81     type: "string"
  82     enum:
  83     - "nbi"
  84   ErrorDetail:
  85     description: ""
  86     required:
  87     - "code"
  88     - "message"
  89     type: "object"
  90     properties:
  91       code:
  92         description: ""
  93         type: "integer"
  94         format: "int32"
  95       message:
  96         description: ""
  97         type: "string"
  98       description:
  99         description: ""
 100         type: "string"
 101       infoURL:
 102         description: ""
 103         type: "string"
 104   Error:
 105     description: ""
 106     required:
 107     - "code"
 108     - "message"
 109     type: "object"
 110     properties:
 111       code:
 112         description: ""
 113         type: "integer"
 114         format: "int32"
 115       message:
 116         description: ""
 117         type: "string"
 118       description:
 119         description: ""
 120         type: "string"
 121       infoURL:
 122         description: ""
 123         type: "string"
 124       details:
 125         type: "array"
 126         items:
 127           $ref: "#/definitions/ErrorDetail"
 128   Component:
 129     description: ""
 130     required:
 131     - "name"
 132     - "status"
 133     type: "object"
 134     properties:
 135       name:
 136         $ref: "#/definitions/ComponentsName"
 137       status:
 138         $ref: "#/definitions/StatusValue"
 139   Status:
 140     description: ""
 141     required:
 142     - "name"
 143     - "status"
 144     - "version"
 145     - "components"
 146     type: "object"
 147     properties:
 148       name:
 149         $ref: "#/definitions/ApplicationName"
 150       status:
 151         $ref: "#/definitions/StatusValue"
 152       version:
 153         description: ""
 154         type: "string"
 155       components:
 156         type: "array"
 157         items:
 158           $ref: "#/definitions/Component"