1 # ========================LICENSE_START=================================
4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
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
10 # http://www.apache.org/licenses/LICENSE-2.0
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===================================
20 description : REST API specification for RIC ANR closed xAPP
24 name : Nokia Closed App
25 url : 'http://www.nokia.com'
33 summary : Health check of ANR - Liveness probe
36 operationId : getHealthAlive
39 description : Status of ANR xApp is ok
42 summary : Health check of ANR - Readiness probe
45 operationId : getHealthReady
48 description : ANR xApp is ready to serve
51 summary : Returns list of gNodeB IDs based on NCRT in ANR
54 operationId : getgNodeB
59 description : successful operation
61 $ref : '#/definitions/ggNodeBTable'
63 description : Unable to retrieve gNodeBs
66 summary : Returns neighbor cell relation table for all gNodeBs or based on query string
71 - $ref : '#/parameters/ggnodeb'
72 - $ref : '#/parameters/servingCellNrcgi'
73 - $ref : '#/parameters/neighborCellNrpci'
78 description : successful operation
80 $ref : '#/definitions/neighborCellRelationTable'
82 description : Unable to retrieve NCRT
83 /ncrt/servingcells/{servCellNrcgi}/neighborcells/{neighCellNrpci} :
85 - $ref : '#/parameters/servCellNrcgi'
86 - $ref : '#/parameters/neighCellNrpci'
88 summary : Modify neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI
91 operationId : modifyNcrt
97 - name : NcrtModificationParameters
99 description : Parameters to modify neighbor cell relation
102 $ref : '#/definitions/neighborCellRelationMod'
105 description : Successfully modified neighbor cell relation
107 description : Modification failed.
108 { Non-existent identifier {servCellNrcgi | neighCellNrpci} in request |
112 description : Modification failed
114 summary : Delete neighbor cell relation based on Source Cell NRCGI and Neighbor Cell NRPCI
117 operationId : deleteNcrt
120 description : Successfully deleted neighbor cell relation
122 description : Deletion failed.
123 { Non-existent identifier {servCellNrcgi | neighCellNrpci} in request }
125 description : Deletion failed
130 description : Global gNodeB Identifier
134 name : servingCellNrcgi
135 description : Serving Cell Identifier (NR CGI)
139 name : neighborCellNrpci
140 description : Neighbor Cell Identifier (NR PCI)
145 description : Serving Cell Identifier (NR CGI)
150 name : neighCellNrpci
151 description : Neighbor Cell Identifier (NR PCI)
161 $ref : '#/definitions/ggnodebId'
162 neighborCellRelationTable :
168 $ref : '#/definitions/neighborCellRelation'
171 description : Global gNodeB Identifier
172 example : ABCDE, EFGHI
173 neighborCellRelation :
185 description : Serving Cell Identifier (NR CGI)
189 description : Neighbor Cell Identifier (NR PCI)
193 description : Neighbor Cell Identifier (NR CGI)
197 description : Flag for HANDOVER NOT ALLOWED
201 description : Flag for Xn CONNECTION NOT ALLOWED
205 description : Flag for DELETION NOT ALLOWED
207 neighborCellRelationMod :
210 - neighborCellIdentifierType
215 description : Neighbor Cell Identifier (NR CGI)
219 description : Flag for HANDOVER NOT ALLOWED
223 description : Flag for Xn CONNECTION NOT ALLOWED
227 description : Flag for DELETION NOT ALLOWED