pkg/api/rest_api.json

   1 {
   2     "swagger" : "2.0",
   3     "info" : {
   4       "description" : "REST API specification xAPP Framework",
   5       "version"     : "0.0.1",
   6       "title"       : "RIC xAPP Framework",
   7       "license" : {
   8         "name" : "",
   9         "url"  : "http://www.nokia.com"
  10       }
  11     },
  12     "host"     : "xapp-service",
  13     "basePath" : "/ric/v1",
  14     "schemes"  : [
  15       "https",
  16       "http"
  17     ],
  18     "paths" : {
  19       "/health/alive" : {
  20         "get" : {
  21           "summary"     : "Health check of xAPP - Liveness probe",
  22           "operationId" : "getHealthAlive",
  23           "responses"   : {
  24             "200" : {
  25               "description" : "Status of xApp is ok"
  26             }
  27           }
  28         }
  29       },
  30       "/health/ready" : {
  31         "get" : {
  32           "summary"     : "Health check of xAPP - Readiness probe",
  33           "operationId" : "getHealthReady",
  34           "responses"   : {
  35             "200" : {
  36               "description" : "Status of xApp is ok"
  37             }
  38           }
  39         }
  40       }
  41     }
  42 }
  43