anr-xapp-client/src/main/resources/anr_swagger_0.0.4.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.4
  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 : Status of ANR xApp is ok
  49   /ncrt/cell :
  50     parameters :
  51       - $ref : '#/parameters/ggnbId'
  52       - $ref : '#/parameters/startIndex'
  53       - $ref : '#/parameters/limit'
  54     get :
  55       summary     : Returns neighbor cell relation table for all gnodeBs or based on query string
  56       tags        :
  57         - ncrt
  58       operationId : getNcrtInfo
  59       produces  :
  60         - application/json
  61       responses :
  62         '200' :
  63           description : successful operation
  64           schema      :
  65             $ref : '#/definitions/neighborCellRelationTable'
  66         '400' :
  67           description : Non-existant identifier {ggnbId | neighborCellIdentifier | start Index} in request
  68   /ncrt/cell/{cellIdentifier} :
  69     parameters :
  70       - $ref : '#/parameters/cellIdentifier'
  71       - $ref : '#/parameters/neighborCellNrpci'
  72       - $ref : '#/parameters/neighborCellNrcgi'
  73     get :
  74       summary     : Returns neighbor cell relation table for a Source Cell (NR CGI) and optionally a neighbor cell based on query string
  75       tags        :
  76         - ncrt
  77       operationId : getCellNcrtInfo
  78       produces  :
  79         - application/json
  80       parameters :
  81         - $ref : '#/parameters/startIndex'
  82         - $ref : '#/parameters/limit'
  83       responses :
  84         '200' :
  85           description : successful operation
  86           schema      :
  87             $ref : '#/definitions/neighborCellRelationTable'
  88         '400' :
  89           description : Non-existant identifier {cellIdentifier | neighborCellNrpci | neighborCellNrcgi} in request
  90     put :
  91       summary     : Modify neighbor cell relation based on Source Cell NR CGI and Target Cell NR PCI / NR CGI
  92       tags        :
  93         - ncrt
  94       operationId : modifyNcrt
  95       consumes   :
  96         - application/json
  97       produces   :
  98         - application/json
  99       parameters :
 100         - name        : NcrtModificationParameters
 101           in          : body
 102           description : Parameters to modify neighbor cell relation
 103           required    : true
 104           schema :
 105             $ref : '#/definitions/neighborCellRelationModTable'
 106       responses :
 107         '200' :
 108           description : Successfully modified neighbor cell relation
 109         '400' :
 110           description : Modification failed.
 111                         { Identifier neighborCellNrpci / neighborCellNrcgi not provided |
 112                           Non-existant identifier {cellIdentifier | neighborCellNrpci | neighborCellNrcgi} in request |
 113                           Invalid data in body
 114                         }
 115     delete :
 116       summary     : Delete neighbor cell relation based on Source Cell NR CGI and Target Cell NR PCI / NR CGI
 117       tags        :
 118         - ncrt
 119       operationId : deleteNcrt
 120       parameters :
 121         - name        : NcrtDeletionParameters
 122           in          : body
 123           description : Parameters to delete neighbor cell relation
 124           required    : true
 125           schema      :
 126             $ref : '#/definitions/neighborCellRelationDelTable'
 127       responses :
 128         '204' :
 129           description : Successfully deleted neighbor cell relation
 130         '400' :
 131           description : Deletion failed.
 132                         { Identifier neighborCellNrpci / neighborCellNrcgi not provided |
 133                           Non-existant identifier {cellIdentifier | neighborCellNrpci | neighborCellNrcgi} in request
 134                         }
 135 parameters :
 136   ggnbId :
 137     type        : string
 138     name        : ggnbId
 139     description : Global gNodeB Identifier
 140     in          : query
 141   startIndex :
 142     type        : string
 143     name        : startIndex
 144     description : Pagination Index
 145     in          : query
 146   limit :
 147     type        : integer
 148     name        : limit
 149     description : Limit of results that client can handle
 150     in          : query
 151   cellIdentifier :
 152     type        : string
 153     name        : cellIdentifier
 154     description : Source Cell Identifier (NR CGI)
 155     in          : path
 156     required    : true
 157   neighborCellNrpci :
 158     type        : string
 159     name        : neighborCellNrpci
 160     description : Neighbor Cell Identifier (NR PCI)
 161     in          : query
 162   neighborCellNrcgi :
 163     type        : string
 164     name        : neighborCellNrcgi
 165     description : Neigbhor Cell Identifier (NR CGI)
 166     in          : query
 167 definitions :
 168   neighborCellRelationTable :
 169     type : object
 170     properties :
 171       ncrtRelations :
 172         type   : array
 173         items  :
 174           $ref : '#/definitions/neighborCellRelation'
 175       startIndex :
 176         type        : string
 177         description : Index to use in REST API to process multipage results
 178         example     : 1245A:6740B
 179   neighborCellRelationModTable :
 180     type   : array
 181     items  :
 182       $ref : '#/definitions/neighborCellRelationMod'
 183   neighborCellRelationDelTable :
 184     type   : array
 185     items  :
 186       $ref : '#/definitions/neighborCellRelationDel'
 187   neighborCellRelation :
 188     type  : object
 189     required :
 190       - cellIdentifierNrcgi
 191       - neighborCellNrpci
 192       - neighborCellNrcgi
 193       - flagNoHo
 194       - flagNoXn
 195       - flagNoRemove
 196     properties :
 197       cellIdentifierNrcgi :
 198         type        : string
 199         description : Source / Serving Cell Identifier (NR CGI)
 200         example     : E12345
 201       neighborCellNrpci :
 202         type        : string
 203         description : Neighbor Cell Identifier (NR PCI)
 204         example     : E12345
 205       neighborCellNrcgi :
 206         type        : string
 207         description : Neighbor Cell Identifier (NR CGI)
 208         example     : E12345
 209       flagNoHo :
 210         type        : boolean
 211         description : Flag for HANDOVER NOT ALLOWED
 212         example     : True
 213       flagNoXn :
 214         type        : boolean
 215         description : Flag for Xn CONNECTION NOT ALLOWED
 216         example     : True
 217       flagNoRemove :
 218         type        : boolean
 219         description : Flag for DELETION NOT ALLOWED
 220         example     : True
 221   neighborCellRelationMod :
 222     type      : object
 223     required  :
 224       - neighbourCellIdentifierType
 225       - action
 226     properties :
 227       neighbourCellIdentifierType :
 228         type        : string
 229         description : Neighbor Cell Identifier Type
 230         enum :
 231           - nrpci
 232           - nrcgi
 233       action :
 234         type        : string
 235         description : Modification action to be performed
 236         enum :
 237           - nrpciToNrcgiMapping
 238           - flagUpdates
 239           - nrcgiMappingAndFlagUpdates
 240       neighborCellNrpci :
 241         type        : string
 242         description : Neighbor Cell Identifier (NR PCI)
 243         example     : E12345
 244       neighborCellNrcgi :
 245         type        : string
 246         description : Neighbor Cell Identifier (NR CGI)
 247         example     : E12345
 248       flagNoHo :
 249         type        : boolean
 250         description : Flag for HANDOVER NOT ALLOWED
 251         example     : True
 252       flagNoXn :
 253         type        : boolean
 254         description : Flag for Xn CONNECTION NOT ALLOWED
 255         example     : True
 256       flagNoRemove :
 257         type        : boolean
 258         description : Flag for DELETION NOT ALLOWED
 259         example     : True
 260   neighborCellRelationDel :
 261     type      : object
 262     required  :
 263       - idType
 264     properties :
 265       idType :
 266         type        : string
 267         description : Modification action to be performed
 268         enum :
 269           - nrpci
 270           - nrcgi
 271       neighborCellNrpci :
 272         type        : string
 273         description : Neighbor Cell Identifier (NR PCI)
 274         example     : E12345
 275       neighborCellNrcgi :
 276         type        : string
 277         description : Neighbor Cell Identifier (NR PCI)
 278         example     : E12345