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