e2-mgr-client/src/main/resources/E2_Manager_API_2019-06-11.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 openapi: 3.0.0
  19 info:
  20   title: E2 Manager Service
  21   description: E2 Manager Service APIs
  22   version: 1.0.0
  23 servers:
  24   - url: 'http://{apiRoot}/v1'
  25     variables:
  26       apiRoot:
  27         default: 'localhost:3800'
  28 paths:
  29   /nodeb/x2-setup:
  30     post:
  31       summary: X2 Setup
  32       tags:
  33         - nodeb
  34       operationId: x2Setup
  35       requestBody:
  36         content:
  37           application/json:
  38             schema:
  39               $ref: '#/components/schemas/SetupRequest'
  40         required: true
  41       responses:
  42         '200':
  43           description: Success
  44         '400':
  45           description: Invalid input
  46           content:
  47             application/problem+json:
  48               schema:
  49                 $ref: '#/components/schemas/ErrorResponse'
  50         '500':
  51           description: Internal error
  52           content:
  53             application/problem+json:
  54               schema:
  55                 $ref: '#/components/schemas/ErrorResponse'
  56   /nodeb/endc-setup:
  57     post:
  58       tags:
  59         - nodeb
  60       summary: ENDC Setup
  61       operationId: endcSetup
  62       requestBody:
  63         content:
  64           application/json:
  65             schema:
  66               $ref: '#/components/schemas/SetupRequest'
  67         required: true
  68       responses:
  69         '200':
  70           description: Success
  71         '400':
  72           description: Invalid input
  73           content:
  74             application/json:
  75               schema:
  76                 $ref: '#/components/schemas/ErrorResponse'
  77         '500':
  78           description: Internal Error
  79           content:
  80             application/problem+json:
  81               schema:
  82                 $ref: '#/components/schemas/ErrorResponse'
  83   '/nodeb/{ranName}':
  84     get:
  85       tags:
  86         - nodeb
  87       summary: Get RAN by name
  88       operationId: getNb
  89       parameters:
  90         - name: ranName
  91           in: path
  92           required: true
  93           description: Name of RAN to return
  94           schema:
  95             type: string
  96       responses:
  97         '200':
  98           description: Successful operation
  99           content:
 100             application/json:
 101               schema:
 102                 $ref: '#/components/schemas/GetNodebResponse'
 103         '400':
 104           description: The specified RAN name is invalid
 105           content:
 106             application/json:
 107               schema:
 108                 $ref: '#/components/schemas/ErrorResponse'
 109         '404':
 110           description: A RAN with the specified name was not found
 111           content:
 112             application/problem+json:
 113               schema:
 114                 $ref: '#/components/schemas/ErrorResponse'
 115         '500':
 116           description: Internal Error
 117           content:
 118             application/problem+json:
 119               schema:
 120                 $ref: '#/components/schemas/ErrorResponse'
 121   /health:
 122     get:
 123       tags:
 124         - Health Check
 125       summary: E2 Manager Service Health Check
 126       responses:
 127         '200':
 128           description: OK
 129 components:
 130   schemas:
 131     SetupRequest:
 132       type: object
 133       required:
 134         - ranIp
 135         - ranPort
 136         - ranName
 137       properties:
 138         ranIp:
 139           type: string
 140         ranPort:
 141           type: integer
 142           format: uint16
 143         ranName:
 144           type: string
 145     GetNodebResponse:
 146       properties:
 147         connectionStatus:
 148           oneOf:
 149             - type: string
 150             - type: integer
 151         enb:
 152           properties:
 153             enbType:
 154               oneOf:
 155                 - type: string
 156                 - type: integer
 157             guGroupIds:
 158               items:
 159                 type: string
 160               type: array
 161             servedCells:
 162               items:
 163                 properties:
 164                   bandwidthReducedSi:
 165                     oneOf:
 166                       - type: string
 167                       - type: integer
 168                   broadcastPlmns:
 169                     items:
 170                       type: string
 171                     type: array
 172                   cellId:
 173                     type: string
 174                   choiceEutraMode:
 175                     properties:
 176                       fdd:
 177                         properties:
 178                           dlTransmissionBandwidth:
 179                             oneOf:
 180                               - type: string
 181                               - type: integer
 182                           dlearFcn:
 183                             type: integer
 184                           ulTransmissionBandwidth:
 185                             oneOf:
 186                               - type: string
 187                               - type: integer
 188                           ulearFcn:
 189                             type: integer
 190                         additionalProperties: false
 191                         type: object
 192                       tdd:
 193                         properties:
 194                           additionalSpecialSubframeExtensionInfo:
 195                             properties:
 196                               additionalSpecialSubframePatternsExtension:
 197                                 oneOf:
 198                                   - type: string
 199                                   - type: integer
 200                               cyclicPrefixDl:
 201                                 oneOf:
 202                                   - type: string
 203                                   - type: integer
 204                               cyclicPrefixUl:
 205                                 oneOf:
 206                                   - type: string
 207                                   - type: integer
 208                             additionalProperties: false
 209                             type: object
 210                           additionalSpecialSubframeInfo:
 211                             properties:
 212                               additionalSpecialSubframePatterns:
 213                                 oneOf:
 214                                   - type: string
 215                                   - type: integer
 216                               cyclicPrefixDl:
 217                                 oneOf:
 218                                   - type: string
 219                                   - type: integer
 220                               cyclicPrefixUl:
 221                                 oneOf:
 222                                   - type: string
 223                                   - type: integer
 224                             additionalProperties: false
 225                             type: object
 226                           earFcn:
 227                             type: integer
 228                           specialSubframeInfo:
 229                             properties:
 230                               cyclicPrefixDl:
 231                                 oneOf:
 232                                   - type: string
 233                                   - type: integer
 234                               cyclicPrefixUl:
 235                                 oneOf:
 236                                   - type: string
 237                                   - type: integer
 238                               specialSubframePatterns:
 239                                 oneOf:
 240                                   - type: string
 241                                   - type: integer
 242                             additionalProperties: false
 243                             type: object
 244                           subframeAssignment:
 245                             oneOf:
 246                               - type: string
 247                               - type: integer
 248                           transmissionBandwidth:
 249                             oneOf:
 250                               - type: string
 251                               - type: integer
 252                         additionalProperties: false
 253                         type: object
 254                     additionalProperties: false
 255                     type: object
 256                   csgId:
 257                     type: string
 258                   eutraMode:
 259                     oneOf:
 260                       - type: string
 261                       - type: integer
 262                   freqBandIndicatorPriority:
 263                     oneOf:
 264                       - type: string
 265                       - type: integer
 266                   mbmsServiceAreaIdentities:
 267                     items:
 268                       type: string
 269                     type: array
 270                   mbsfnSubframeInfos:
 271                     items:
 272                       properties:
 273                         radioframeAllocationOffset:
 274                           type: integer
 275                         radioframeAllocationPeriod:
 276                           oneOf:
 277                             - type: string
 278                             - type: integer
 279                         subframeAllocation:
 280                           type: string
 281                         subframeAllocationType:
 282                           oneOf:
 283                             - type: string
 284                             - type: integer
 285                       additionalProperties: false
 286                       type: object
 287                     type: array
 288                   multibandInfos:
 289                     items:
 290                       type: integer
 291                     type: array
 292                   neighbourInfos:
 293                     items:
 294                       properties:
 295                         earFcn:
 296                           type: integer
 297                         ecgi:
 298                           type: string
 299                         pci:
 300                           type: integer
 301                         tac:
 302                           type: string
 303                       additionalProperties: false
 304                       type: object
 305                     type: array
 306                   numberOfAntennaPorts:
 307                     oneOf:
 308                       - type: string
 309                       - type: integer
 310                   pci:
 311                     type: integer
 312                   prachConfiguration:
 313                     properties:
 314                       highSpeedFlag:
 315                         type: boolean
 316                       prachConfigurationIndex:
 317                         type: integer
 318                       prachFrequencyOffset:
 319                         type: integer
 320                       rootSequenceIndex:
 321                         type: integer
 322                       zeroCorrelationZoneConfiguration:
 323                         type: integer
 324                     additionalProperties: false
 325                     type: object
 326                   tac:
 327                     type: string
 328                 additionalProperties: false
 329                 type: object
 330               type: array
 331           additionalProperties: false
 332           type: object
 333         failureType:
 334           oneOf:
 335             - type: string
 336             - type: integer
 337         gnb:
 338           properties:
 339             servedNrCells:
 340               items:
 341                 properties:
 342                   nrNeighbourInfos:
 343                     items:
 344                       properties:
 345                         choiceNrMode:
 346                           properties:
 347                             fdd:
 348                               properties:
 349                                 dlarFcnFreqInfo:
 350                                   properties:
 351                                     frequencyBands:
 352                                       items:
 353                                         properties:
 354                                           nrFrequencyBand:
 355                                             type: integer
 356                                           supportedSulBands:
 357                                             items:
 358                                               type: integer
 359                                             type: array
 360                                         additionalProperties: false
 361                                         type: object
 362                                       type: array
 363                                     nrArFcn:
 364                                       oneOf:
 365                                         - type: integer
 366                                     sulInformation:
 367                                       properties:
 368                                         sulArFcn:
 369                                           oneOf:
 370                                             - type: integer
 371                                         sulTransmissionBandwidth:
 372                                           properties:
 373                                             ncnrb:
 374                                               oneOf:
 375                                                 - type: string
 376                                                 - type: integer
 377                                             nrscs:
 378                                               oneOf:
 379                                                 - type: string
 380                                                 - type: integer
 381                                           additionalProperties: false
 382                                           type: object
 383                                       additionalProperties: false
 384                                       type: object
 385                                   additionalProperties: false
 386                                   type: object
 387                                 ularFcnFreqInfo:
 388                                   properties:
 389                                     frequencyBands:
 390                                       items:
 391                                         properties:
 392                                           nrFrequencyBand:
 393                                             type: integer
 394                                           supportedSulBands:
 395                                             items:
 396                                               type: integer
 397                                             type: array
 398                                         additionalProperties: false
 399                                         type: object
 400                                       type: array
 401                                     nrArFcn:
 402                                       oneOf:
 403                                         - type: integer
 404                                     sulInformation:
 405                                       properties:
 406                                         sulArFcn:
 407                                           oneOf:
 408                                             - type: integer
 409                                         sulTransmissionBandwidth:
 410                                           properties:
 411                                             ncnrb:
 412                                               oneOf:
 413                                                 - type: string
 414                                                 - type: integer
 415                                             nrscs:
 416                                               oneOf:
 417                                                 - type: string
 418                                                 - type: integer
 419                                           additionalProperties: false
 420                                           type: object
 421                                       additionalProperties: false
 422                                       type: object
 423                                   additionalProperties: false
 424                                   type: object
 425                               additionalProperties: false
 426                               type: object
 427                             tdd:
 428                               properties:
 429                                 arFcnNrFreqInfo:
 430                                   properties:
 431                                     frequencyBands:
 432                                       items:
 433                                         properties:
 434                                           nrFrequencyBand:
 435                                             type: integer
 436                                           supportedSulBands:
 437                                             items:
 438                                               type: integer
 439                                             type: array
 440                                         additionalProperties: false
 441                                         type: object
 442                                       type: array
 443                                     nrArFcn:
 444                                       oneOf:
 445                                         - type: integer
 446                                     sulInformation:
 447                                       properties:
 448                                         sulArFcn:
 449                                           oneOf:
 450                                             - type: integer
 451                                         sulTransmissionBandwidth:
 452                                           properties:
 453                                             ncnrb:
 454                                               oneOf:
 455                                                 - type: string
 456                                                 - type: integer
 457                                             nrscs:
 458                                               oneOf:
 459                                                 - type: string
 460                                                 - type: integer
 461                                           additionalProperties: false
 462                                           type: object
 463                                       additionalProperties: false
 464                                       type: object
 465                                   additionalProperties: false
 466                                   type: object
 467                               additionalProperties: false
 468                               type: object
 469                           additionalProperties: false
 470                           type: object
 471                         configuredStac:
 472                           type: string
 473                         nrCgi:
 474                           type: string
 475                         nrMode:
 476                           oneOf:
 477                             - type: string
 478                             - type: integer
 479                         nrPci:
 480                           type: integer
 481                         stac5g:
 482                           type: string
 483                       additionalProperties: false
 484                       type: object
 485                     type: array
 486                   servedNrCellInformation:
 487                     properties:
 488                       cellId:
 489                         type: string
 490                       choiceNrMode:
 491                         properties:
 492                           fdd:
 493                             properties:
 494                               dlFreqInfo:
 495                                 properties:
 496                                   frequencyBands:
 497                                     items:
 498                                       properties:
 499                                         nrFrequencyBand:
 500                                           type: integer
 501                                         supportedSulBands:
 502                                           items:
 503                                             type: integer
 504                                           type: array
 505                                       additionalProperties: false
 506                                       type: object
 507                                     type: array
 508                                   nrArFcn:
 509                                     oneOf:
 510                                       - type: integer
 511                                   sulInformation:
 512                                     properties:
 513                                       sulArFcn:
 514                                         oneOf:
 515                                           - type: integer
 516                                       sulTransmissionBandwidth:
 517                                         properties:
 518                                           ncnrb:
 519                                             oneOf:
 520                                               - type: string
 521                                               - type: integer
 522                                           nrscs:
 523                                             oneOf:
 524                                               - type: string
 525                                               - type: integer
 526                                         additionalProperties: false
 527                                         type: object
 528                                     additionalProperties: false
 529                                     type: object
 530                                 additionalProperties: false
 531                                 type: object
 532                               dlTransmissionBandwidth:
 533                                 properties:
 534                                   ncnrb:
 535                                     oneOf:
 536                                       - type: string
 537                                       - type: integer
 538                                   nrscs:
 539                                     oneOf:
 540                                       - type: string
 541                                       - type: integer
 542                                 additionalProperties: false
 543                                 type: object
 544                               ulFreqInfo:
 545                                 properties:
 546                                   frequencyBands:
 547                                     items:
 548                                       properties:
 549                                         nrFrequencyBand:
 550                                           type: integer
 551                                         supportedSulBands:
 552                                           items:
 553                                             type: integer
 554                                           type: array
 555                                       additionalProperties: false
 556                                       type: object
 557                                     type: array
 558                                   nrArFcn:
 559                                     oneOf:
 560                                       - type: integer
 561                                   sulInformation:
 562                                     properties:
 563                                       sulArFcn:
 564                                         oneOf:
 565                                           - type: integer
 566                                       sulTransmissionBandwidth:
 567                                         properties:
 568                                           ncnrb:
 569                                             oneOf:
 570                                               - type: string
 571                                               - type: integer
 572                                           nrscs:
 573                                             oneOf:
 574                                               - type: string
 575                                               - type: integer
 576                                         additionalProperties: false
 577                                         type: object
 578                                     additionalProperties: false
 579                                     type: object
 580                                 additionalProperties: false
 581                                 type: object
 582                               ulTransmissionBandwidth:
 583                                 properties:
 584                                   ncnrb:
 585                                     oneOf:
 586                                       - type: string
 587                                       - type: integer
 588                                   nrscs:
 589                                     oneOf:
 590                                       - type: string
 591                                       - type: integer
 592                                 additionalProperties: false
 593                                 type: object
 594                             additionalProperties: false
 595                             type: object
 596                           tdd:
 597                             properties:
 598                               nrFreqInfo:
 599                                 properties:
 600                                   frequencyBands:
 601                                     items:
 602                                       properties:
 603                                         nrFrequencyBand:
 604                                           type: integer
 605                                         supportedSulBands:
 606                                           items:
 607                                             type: integer
 608                                           type: array
 609                                       additionalProperties: false
 610                                       type: object
 611                                     type: array
 612                                   nrArFcn:
 613                                     oneOf:
 614                                       - type: integer
 615                                   sulInformation:
 616                                     properties:
 617                                       sulArFcn:
 618                                         oneOf:
 619                                           - type: integer
 620                                       sulTransmissionBandwidth:
 621                                         properties:
 622                                           ncnrb:
 623                                             oneOf:
 624                                               - type: string
 625                                               - type: integer
 626                                           nrscs:
 627                                             oneOf:
 628                                               - type: string
 629                                               - type: integer
 630                                         additionalProperties: false
 631                                         type: object
 632                                     additionalProperties: false
 633                                     type: object
 634                                 additionalProperties: false
 635                                 type: object
 636                               transmissionBandwidth:
 637                                 properties:
 638                                   ncnrb:
 639                                     oneOf:
 640                                       - type: string
 641                                       - type: integer
 642                                   nrscs:
 643                                     oneOf:
 644                                       - type: string
 645                                       - type: integer
 646                                 additionalProperties: false
 647                                 type: object
 648                             additionalProperties: false
 649                             type: object
 650                         additionalProperties: false
 651                         type: object
 652                       configuredStac:
 653                         type: string
 654                       nrMode:
 655                         oneOf:
 656                           - type: string
 657                           - type: integer
 658                       nrPci:
 659                         type: integer
 660                       servedPlmns:
 661                         items:
 662                           type: string
 663                         type: array
 664                       stac5g:
 665                         type: string
 666                     additionalProperties: false
 667                     type: object
 668                 additionalProperties: false
 669                 type: object
 670               type: array
 671           additionalProperties: false
 672           type: object
 673         ip:
 674           type: string
 675         nodeType:
 676           oneOf:
 677             - type: string
 678             - type: integer
 679         port:
 680           type: integer
 681         ranName:
 682           type: string
 683         setupFailure:
 684           properties:
 685             criticalityDiagnostics:
 686               properties:
 687                 informationElementCriticalityDiagnostics:
 688                   items:
 689                     properties:
 690                       ieCriticality:
 691                         oneOf:
 692                           - type: string
 693                           - type: integer
 694                       ieId:
 695                         type: integer
 696                       typeOfError:
 697                         oneOf:
 698                           - type: string
 699                           - type: integer
 700                     additionalProperties: false
 701                     type: object
 702                   type: array
 703                 procedureCode:
 704                   type: integer
 705                 procedureCriticality:
 706                   oneOf:
 707                     - type: string
 708                     - type: integer
 709                 triggeringMessage:
 710                   oneOf:
 711                     - type: string
 712                     - type: integer
 713               additionalProperties: false
 714               type: object
 715             miscellaneousCause:
 716               oneOf:
 717                 - type: string
 718                 - type: integer
 719             networkLayerCause:
 720               oneOf:
 721                 - type: string
 722                 - type: integer
 723             protocolCause:
 724               oneOf:
 725                 - type: string
 726                 - type: integer
 727             timeToWait:
 728               oneOf:
 729                 - type: string
 730                 - type: integer
 731             transportLayerCause:
 732               oneOf:
 733                 - type: string
 734                 - type: integer
 735           additionalProperties: false
 736           type: object
 737       additionalProperties: false
 738       type: object
 739     ErrorResponse:
 740       type: object
 741       required:
 742         - errorCode
 743         - errorMessage
 744       properties:
 745         errorCode:
 746           type: string
 747           description: '401 - corrupted json, 402 - validation error, 501 - internal problem'
 748         errorMessage:
 749           type: string
 750           description: Human readable text