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

   1 # ========================LICENSE_START=================================
   2 # O-RAN-SC
   3 # %%
   4 # Copyright (C) 2019 AT&T Intellectual Property
   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.8
  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   /ncrt/gnodebs :
  50     get :
  51       summary     : Returns list of gNodeB IDs based on NCRT in ANR
  52       tags        :
  53         - ncrt
  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/servingcells :
  65     get :
  66       summary     : Returns neighbor cell relation table for all gNodeBs or based on query string
  67       tags        :
  68         - ncrt
  69       operationId : getNcrt
  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                         {
 109                           Non-existent servCellNrcgi in request. |
 110                           Non-existent neighCellNrpci in request.
 111                         }
 112         '405' :
 113           description : Modification failed.
 114                         {
 115                           No data to udpate. |
 116                           Invalid data in BODY. |
 117                           Parameter missing in BODY.
 118                         }
 119         '500' :
 120           description : Modification failed.
 121     delete :
 122       summary     : Delete neighbor cell relation based on Source Cell NRCGI and Neighbor Cell NRPCI
 123       tags        :
 124         - ncrt
 125       operationId : deleteNcrt
 126       responses :
 127         '204' :
 128           description : Successfully deleted neighbor cell relation
 129         '400' :
 130           description : Deletion failed.
 131                         {
 132                           Non-existent servCellNrcgi in request. |
 133                           Non-existent neighCellNrpci in request.
 134                         }
 135         '500' :
 136           description : Deletion failed.
 137 parameters :
 138   ggnodeb :
 139     type        : string
 140     name        : ggnodeb
 141     description : Global gNodeB Identifier
 142     in          : query
 143   servingCellNrcgi :
 144     type        : string
 145     name        : servingCellNrcgi
 146     description : Serving Cell Identifier (NR CGI)
 147     in          : query
 148   neighborCellNrpci :
 149     type        : string
 150     name        : neighborCellNrpci
 151     description : Neighbor Cell Identifier (NR PCI)
 152     in          : query
 153   servCellNrcgi :
 154     type        : string
 155     name        : servCellNrcgi
 156     description : Serving Cell Identifier (NR CGI)
 157     in          : path
 158     required   : true
 159   neighCellNrpci :
 160     type        : string
 161     name        : neighCellNrpci
 162     description : Neighbor Cell Identifier (NR PCI)
 163     in          : path
 164     required    : true
 165 definitions :
 166   ggNodeBTable :
 167     type : object
 168     properties :
 169       gNodeBIds :
 170         type   : array
 171         items  :
 172           $ref : '#/definitions/ggnodebId'
 173   neighborCellRelationTable :
 174     type : object
 175     properties :
 176       ncrtRelations :
 177         type   : array
 178         items  :
 179           $ref : '#/definitions/neighborCellRelation'
 180   ggnodebId :
 181     type        : string
 182     description : Global gNodeB Identifier
 183     example     : ABCDE, EFGHI
 184   neighborCellRelation :
 185     type  : object
 186     required :
 187       - servingCellNrcgi
 188       - neighborCellNrpci
 189       - neighborCellNrcgi
 190       - flagNoHo
 191       - flagNoXn
 192       - flagNoRemove
 193     properties :
 194       servingCellNrcgi :
 195         type        : string
 196         description : Serving Cell Identifier (NR CGI)
 197         example     : E12345
 198       neighborCellNrpci :
 199         type        : string
 200         description : Neighbor Cell Identifier (NR PCI)
 201         example     : E12345
 202       neighborCellNrcgi :
 203         type        : string
 204         description : Neighbor Cell Identifier (NR CGI)
 205         example     : E12345
 206       flagNoHo :
 207         type        : boolean
 208         description : Flag for HANDOVER NOT ALLOWED
 209         example     : True
 210       flagNoXn :
 211         type        : boolean
 212         description : Flag for Xn CONNECTION NOT ALLOWED
 213         example     : True
 214       flagNoRemove :
 215         type        : boolean
 216         description : Flag for DELETION NOT ALLOWED
 217         example     : True
 218   neighborCellRelationMod :
 219     type      : object
 220     required  :
 221       - neighborCellIdentifierType
 222       - action
 223     properties :
 224       neighborCellNrcgi :
 225         type        : string
 226         description : Neighbor Cell Identifier (NR CGI)
 227         example     : E12345
 228       flagNoHo :
 229         type        : boolean
 230         description : Flag for HANDOVER NOT ALLOWED
 231         example     : True
 232       flagNoXn :
 233         type        : boolean
 234         description : Flag for Xn CONNECTION NOT ALLOWED
 235         example     : True
 236       flagNoRemove :
 237         type        : boolean
 238         description : Flag for DELETION NOT ALLOWED
 239         example     : True