anr-xapp-client/src/main/resources/anr_swagger_0.0.6.yaml

   1 # ========================LICENSE_START=================================
   2 # O-RAN-SC
   3 # %%
   4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
   5 # %%
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #      http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17 # ========================LICENSE_END===================================
  18 swagger : '2.0'
  19 info :
  20   description : REST API specification for RIC ANR closed xAPP
  21   version     : 0.0.6
  22   title       : RIC ANR
  23   license:
  24     name : Nokia Closed App
  25     url  : 'http://www.nokia.com'
  26 host     : anr-service
  27 basePath : /ric/v1
  28 schemes :
  29   - http
  30 paths :
  31   /health/alive :
  32     get :
  33       summary     : Health check of ANR - Liveness probe
  34       tags        :
  35         - health
  36       operationId : getHealthAlive
  37       responses   :
  38         '200' :
  39           description : Status of ANR xApp is ok
  40   /health/ready :
  41     get :
  42       summary     : Health check of ANR - Readiness probe
  43       tags        :
  44         - health
  45       operationId : getHealthReady
  46       responses   :
  47         '200':
  48           description : ANR xApp is ready to serve
  49   /gnodebs :
  50     get :
  51       summary     : Returns list of gNodeB IDs based on NCRT in ANR
  52       tags        :
  53         - gnodebs
  54       operationId : getgNodeB
  55       produces  :
  56         - application/json
  57       responses :
  58         '200' :
  59           description : successful operation
  60           schema      :
  61             $ref : '#/definitions/ggNodeBTable'
  62         '500' :
  63           description : Unable to retrieve gNodeBs
  64   /ncrt :
  65     get :
  66       summary     : Returns neighbor cell relation table for all gNodeBs or based on query string
  67       tags        :
  68         - ncrt
  69       operationId : getNcrtInfo
  70       parameters :
  71         - $ref : '#/parameters/ggnodeb'
  72         - $ref : '#/parameters/servingCellNrcgi'
  73         - $ref : '#/parameters/neighborCellNrpci'
  74       produces  :
  75         - application/json
  76       responses :
  77         '200' :
  78           description : successful operation
  79           schema      :
  80             $ref : '#/definitions/neighborCellRelationTable'
  81         '500' :
  82           description : Unable to retrieve NCRT
  83   /ncrt/servingcells/{servCellNrcgi}/neighborcells/{neighCellNrpci} :
  84     parameters :
  85       - $ref : '#/parameters/servCellNrcgi'
  86       - $ref : '#/parameters/neighCellNrpci'
  87     put :
  88       summary     : Modify neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI
  89       tags        :
  90         - ncrt
  91       operationId : modifyNcrt
  92       consumes   :
  93         - application/json
  94       produces   :
  95         - application/json
  96       parameters :
  97         - name        : NcrtModificationParameters
  98           in          : body
  99           description : Parameters to modify neighbor cell relation
 100           required    : true
 101           schema :
 102             $ref : '#/definitions/neighborCellRelationMod'
 103       responses :
 104         '200' :
 105           description : Successfully modified neighbor cell relation
 106         '400' :
 107           description : Modification failed.
 108                         { Non-existent identifier {servCellNrcgi | neighCellNrpci} in request |
 109                           Invalid data in body
 110                         }
 111         '500' :
 112           description : Modification failed
 113     delete :
 114       summary     : Delete neighbor cell relation based on Source Cell NRCGI and Neighbor Cell NRPCI
 115       tags        :
 116         - ncrt
 117       operationId : deleteNcrt
 118       responses :
 119         '204' :
 120           description : Successfully deleted neighbor cell relation
 121         '400' :
 122           description : Deletion failed.
 123                         { Non-existent identifier {servCellNrcgi | neighCellNrpci} in request }
 124         '500' :
 125           description : Deletion failed
 126 parameters :
 127   ggnodeb :
 128     type        : string
 129     name        : ggnodeb
 130     description : Global gNodeB Identifier
 131     in          : query
 132   servingCellNrcgi :
 133     type        : string
 134     name        : servingCellNrcgi
 135     description : Serving Cell Identifier (NR CGI)
 136     in          : query
 137   neighborCellNrpci :
 138     type        : string
 139     name        : neighborCellNrpci
 140     description : Neighbor Cell Identifier (NR PCI)
 141     in          : query
 142   servCellNrcgi :
 143     type        : string
 144     name        : servCellNrcgi
 145     description : Serving Cell Identifier (NR CGI)
 146     in          : path
 147     required   : true
 148   neighCellNrpci :
 149     type        : string
 150     name        : neighCellNrpci
 151     description : Neighbor Cell Identifier (NR PCI)
 152     in          : path
 153     required    : true
 154 definitions :
 155   ggNodeBTable :
 156     type : object
 157     properties :
 158       gNodeBIds :
 159         type   : array
 160         items  :
 161           $ref : '#/definitions/ggnodebId'
 162   neighborCellRelationTable :
 163     type : object
 164     properties :
 165       ncrtRelations :
 166         type   : array
 167         items  :
 168           $ref : '#/definitions/neighborCellRelation'
 169   ggnodebId :
 170     type        : string
 171     description : Global gNodeB Identifier
 172     example     : ABCDE, EFGHI
 173   neighborCellRelation :
 174     type  : object
 175     required :
 176       - servingCellNrcgi
 177       - neighborCellNrpci
 178       - neighborCellNrcgi
 179       - flagNoHo
 180       - flagNoXn
 181       - flagNoRemove
 182     properties :
 183       servingCellNrcgi :
 184         type        : string
 185         description : Serving Cell Identifier (NR CGI)
 186         example     : E12345
 187       neighborCellNrpci :
 188         type        : string
 189         description : Neighbor Cell Identifier (NR PCI)
 190         example     : E12345
 191       neighborCellNrcgi :
 192         type        : string
 193         description : Neighbor Cell Identifier (NR CGI)
 194         example     : E12345
 195       flagNoHo :
 196         type        : boolean
 197         description : Flag for HANDOVER NOT ALLOWED
 198         example     : True
 199       flagNoXn :
 200         type        : boolean
 201         description : Flag for Xn CONNECTION NOT ALLOWED
 202         example     : True
 203       flagNoRemove :
 204         type        : boolean
 205         description : Flag for DELETION NOT ALLOWED
 206         example     : True
 207   neighborCellRelationMod :
 208     type      : object
 209     required  :
 210       - neighborCellIdentifierType
 211       - action
 212     properties :
 213       neighborCellNrcgi :
 214         type        : string
 215         description : Neighbor Cell Identifier (NR CGI)
 216         example     : E12345
 217       flagNoHo :
 218         type        : boolean
 219         description : Flag for HANDOVER NOT ALLOWED
 220         example     : True
 221       flagNoXn :
 222         type        : boolean
 223         description : Flag for Xn CONNECTION NOT ALLOWED
 224         example     : True
 225       flagNoRemove :
 226         type        : boolean
 227         description : Flag for DELETION NOT ALLOWED
 228         example     : True