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