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.
109 Non-existent servCellNrcgi in request. |
110 Non-existent neighCellNrpci in request.
113 description : Modification failed.
116 Invalid data in BODY. |
117 Parameter missing in BODY.
120 description : Modification failed.
122 summary : Delete neighbor cell relation based on Source Cell NRCGI and Neighbor Cell NRPCI
125 operationId : deleteNcrt
128 description : Successfully deleted neighbor cell relation
130 description : Deletion failed.
132 Non-existent servCellNrcgi in request. |
133 Non-existent neighCellNrpci in request.
136 description : Deletion failed.
141 description : Global gNodeB Identifier
145 name : servingCellNrcgi
146 description : Serving Cell Identifier (NR CGI)
150 name : neighborCellNrpci
151 description : Neighbor Cell Identifier (NR PCI)
156 description : Serving Cell Identifier (NR CGI)
161 name : neighCellNrpci
162 description : Neighbor Cell Identifier (NR PCI)
172 $ref : '#/definitions/ggnodebId'
173 neighborCellRelationTable :
179 $ref : '#/definitions/neighborCellRelation'
182 description : Global gNodeB Identifier
183 example : ABCDE, EFGHI
184 neighborCellRelation :
196 description : Serving Cell Identifier (NR CGI)
200 description : Neighbor Cell Identifier (NR PCI)
204 description : Neighbor Cell Identifier (NR CGI)
208 description : Flag for HANDOVER NOT ALLOWED
212 description : Flag for Xn CONNECTION NOT ALLOWED
216 description : Flag for DELETION NOT ALLOWED
218 neighborCellRelationMod :
221 - neighborCellIdentifierType
226 description : Neighbor Cell Identifier (NR CGI)
230 description : Flag for HANDOVER NOT ALLOWED
234 description : Flag for Xn CONNECTION NOT ALLOWED
238 description : Flag for DELETION NOT ALLOWED