e2-mgr-client/src/main/resources/E2_Manager_API_2019-06-26.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         gnb:
 387           properties:
 388             servedNrCells:
 389               items:
 390                 properties:
 391                   nrNeighbourInfos:
 392                     items:
 393                       properties:
 394                         choiceNrMode:
 395                           properties:
 396                             fdd:
 397                               properties:
 398                                 dlarFcnFreqInfo:
 399                                   properties:
 400                                     frequencyBands:
 401                                       items:
 402                                         properties:
 403                                           nrFrequencyBand:
 404                                             type: integer
 405                                           supportedSulBands:
 406                                             items:
 407                                               type: integer
 408                                             type: array
 409                                         additionalProperties: false
 410                                         type: object
 411                                       type: array
 412                                     nrArFcn:
 413                                       oneOf:
 414                                         - type: integer
 415                                     sulInformation:
 416                                       properties:
 417                                         sulArFcn:
 418                                           oneOf:
 419                                             - type: integer
 420                                         sulTransmissionBandwidth:
 421                                           properties:
 422                                             ncnrb:
 423                                               oneOf:
 424                                                 - type: string
 425                                                 - type: integer
 426                                             nrscs:
 427                                               oneOf:
 428                                                 - type: string
 429                                                 - type: integer
 430                                           additionalProperties: false
 431                                           type: object
 432                                       additionalProperties: false
 433                                       type: object
 434                                   additionalProperties: false
 435                                   type: object
 436                                 ularFcnFreqInfo:
 437                                   properties:
 438                                     frequencyBands:
 439                                       items:
 440                                         properties:
 441                                           nrFrequencyBand:
 442                                             type: integer
 443                                           supportedSulBands:
 444                                             items:
 445                                               type: integer
 446                                             type: array
 447                                         additionalProperties: false
 448                                         type: object
 449                                       type: array
 450                                     nrArFcn:
 451                                       oneOf:
 452                                         - type: integer
 453                                     sulInformation:
 454                                       properties:
 455                                         sulArFcn:
 456                                           oneOf:
 457                                             - type: integer
 458                                         sulTransmissionBandwidth:
 459                                           properties:
 460                                             ncnrb:
 461                                               oneOf:
 462                                                 - type: string
 463                                                 - type: integer
 464                                             nrscs:
 465                                               oneOf:
 466                                                 - type: string
 467                                                 - type: integer
 468                                           additionalProperties: false
 469                                           type: object
 470                                       additionalProperties: false
 471                                       type: object
 472                                   additionalProperties: false
 473                                   type: object
 474                               additionalProperties: false
 475                               type: object
 476                             tdd:
 477                               properties:
 478                                 arFcnNrFreqInfo:
 479                                   properties:
 480                                     frequencyBands:
 481                                       items:
 482                                         properties:
 483                                           nrFrequencyBand:
 484                                             type: integer
 485                                           supportedSulBands:
 486                                             items:
 487                                               type: integer
 488                                             type: array
 489                                         additionalProperties: false
 490                                         type: object
 491                                       type: array
 492                                     nrArFcn:
 493                                       oneOf:
 494                                         - type: integer
 495                                     sulInformation:
 496                                       properties:
 497                                         sulArFcn:
 498                                           oneOf:
 499                                             - type: integer
 500                                         sulTransmissionBandwidth:
 501                                           properties:
 502                                             ncnrb:
 503                                               oneOf:
 504                                                 - type: string
 505                                                 - type: integer
 506                                             nrscs:
 507                                               oneOf:
 508                                                 - type: string
 509                                                 - type: integer
 510                                           additionalProperties: false
 511                                           type: object
 512                                       additionalProperties: false
 513                                       type: object
 514                                   additionalProperties: false
 515                                   type: object
 516                               additionalProperties: false
 517                               type: object
 518                           additionalProperties: false
 519                           type: object
 520                         configuredStac:
 521                           type: string
 522                         nrCgi:
 523                           type: string
 524                         nrMode:
 525                           oneOf:
 526                             - type: string
 527                             - type: integer
 528                         nrPci:
 529                           type: integer
 530                         stac5g:
 531                           type: string
 532                       additionalProperties: false
 533                       type: object
 534                     type: array
 535                   servedNrCellInformation:
 536                     properties:
 537                       cellId:
 538                         type: string
 539                       choiceNrMode:
 540                         properties:
 541                           fdd:
 542                             properties:
 543                               dlFreqInfo:
 544                                 properties:
 545                                   frequencyBands:
 546                                     items:
 547                                       properties:
 548                                         nrFrequencyBand:
 549                                           type: integer
 550                                         supportedSulBands:
 551                                           items:
 552                                             type: integer
 553                                           type: array
 554                                       additionalProperties: false
 555                                       type: object
 556                                     type: array
 557                                   nrArFcn:
 558                                     oneOf:
 559                                       - type: integer
 560                                   sulInformation:
 561                                     properties:
 562                                       sulArFcn:
 563                                         oneOf:
 564                                           - type: integer
 565                                       sulTransmissionBandwidth:
 566                                         properties:
 567                                           ncnrb:
 568                                             oneOf:
 569                                               - type: string
 570                                               - type: integer
 571                                           nrscs:
 572                                             oneOf:
 573                                               - type: string
 574                                               - type: integer
 575                                         additionalProperties: false
 576                                         type: object
 577                                     additionalProperties: false
 578                                     type: object
 579                                 additionalProperties: false
 580                                 type: object
 581                               dlTransmissionBandwidth:
 582                                 properties:
 583                                   ncnrb:
 584                                     oneOf:
 585                                       - type: string
 586                                       - type: integer
 587                                   nrscs:
 588                                     oneOf:
 589                                       - type: string
 590                                       - type: integer
 591                                 additionalProperties: false
 592                                 type: object
 593                               ulFreqInfo:
 594                                 properties:
 595                                   frequencyBands:
 596                                     items:
 597                                       properties:
 598                                         nrFrequencyBand:
 599                                           type: integer
 600                                         supportedSulBands:
 601                                           items:
 602                                             type: integer
 603                                           type: array
 604                                       additionalProperties: false
 605                                       type: object
 606                                     type: array
 607                                   nrArFcn:
 608                                     oneOf:
 609                                       - type: integer
 610                                   sulInformation:
 611                                     properties:
 612                                       sulArFcn:
 613                                         oneOf:
 614                                           - type: integer
 615                                       sulTransmissionBandwidth:
 616                                         properties:
 617                                           ncnrb:
 618                                             oneOf:
 619                                               - type: string
 620                                               - type: integer
 621                                           nrscs:
 622                                             oneOf:
 623                                               - type: string
 624                                               - type: integer
 625                                         additionalProperties: false
 626                                         type: object
 627                                     additionalProperties: false
 628                                     type: object
 629                                 additionalProperties: false
 630                                 type: object
 631                               ulTransmissionBandwidth:
 632                                 properties:
 633                                   ncnrb:
 634                                     oneOf:
 635                                       - type: string
 636                                       - type: integer
 637                                   nrscs:
 638                                     oneOf:
 639                                       - type: string
 640                                       - type: integer
 641                                 additionalProperties: false
 642                                 type: object
 643                             additionalProperties: false
 644                             type: object
 645                           tdd:
 646                             properties:
 647                               nrFreqInfo:
 648                                 properties:
 649                                   frequencyBands:
 650                                     items:
 651                                       properties:
 652                                         nrFrequencyBand:
 653                                           type: integer
 654                                         supportedSulBands:
 655                                           items:
 656                                             type: integer
 657                                           type: array
 658                                       additionalProperties: false
 659                                       type: object
 660                                     type: array
 661                                   nrArFcn:
 662                                     oneOf:
 663                                       - type: integer
 664                                   sulInformation:
 665                                     properties:
 666                                       sulArFcn:
 667                                         oneOf:
 668                                           - type: integer
 669                                       sulTransmissionBandwidth:
 670                                         properties:
 671                                           ncnrb:
 672                                             oneOf:
 673                                               - type: string
 674                                               - type: integer
 675                                           nrscs:
 676                                             oneOf:
 677                                               - type: string
 678                                               - type: integer
 679                                         additionalProperties: false
 680                                         type: object
 681                                     additionalProperties: false
 682                                     type: object
 683                                 additionalProperties: false
 684                                 type: object
 685                               transmissionBandwidth:
 686                                 properties:
 687                                   ncnrb:
 688                                     oneOf:
 689                                       - type: string
 690                                       - type: integer
 691                                   nrscs:
 692                                     oneOf:
 693                                       - type: string
 694                                       - type: integer
 695                                 additionalProperties: false
 696                                 type: object
 697                             additionalProperties: false
 698                             type: object
 699                         additionalProperties: false
 700                         type: object
 701                       configuredStac:
 702                         type: string
 703                       nrMode:
 704                         oneOf:
 705                           - type: string
 706                           - type: integer
 707                       nrPci:
 708                         type: integer
 709                       servedPlmns:
 710                         items:
 711                           type: string
 712                         type: array
 713                       stac5g:
 714                         type: string
 715                     additionalProperties: false
 716                     type: object
 717                 additionalProperties: false
 718                 type: object
 719               type: array
 720           additionalProperties: false
 721           type: object
 722         ip:
 723           type: string
 724         nodeType:
 725           oneOf:
 726             - type: string
 727             - type: integer
 728         port:
 729           type: integer
 730         ranName:
 731           type: string
 732         setupFailure:
 733           properties:
 734             criticalityDiagnostics:
 735               properties:
 736                 informationElementCriticalityDiagnostics:
 737                   items:
 738                     properties:
 739                       ieCriticality:
 740                         oneOf:
 741                           - type: string
 742                           - type: integer
 743                       ieId:
 744                         type: integer
 745                       typeOfError:
 746                         oneOf:
 747                           - type: string
 748                           - type: integer
 749                     additionalProperties: false
 750                     type: object
 751                   type: array
 752                 procedureCode:
 753                   type: integer
 754                 procedureCriticality:
 755                   oneOf:
 756                     - type: string
 757                     - type: integer
 758                 triggeringMessage:
 759                   oneOf:
 760                     - type: string
 761                     - type: integer
 762               additionalProperties: false
 763               type: object
 764             miscellaneousCause:
 765               oneOf:
 766                 - type: string
 767                 - type: integer
 768             networkLayerCause:
 769               oneOf:
 770                 - type: string
 771                 - type: integer
 772             protocolCause:
 773               oneOf:
 774                 - type: string
 775                 - type: integer
 776             timeToWait:
 777               oneOf:
 778                 - type: string
 779                 - type: integer
 780             transportLayerCause:
 781               oneOf:
 782                 - type: string
 783                 - type: integer
 784           additionalProperties: false
 785           type: object
 786       additionalProperties: false
 787       type: object
 788     ErrorResponse:
 789       type: object
 790       required:
 791         - errorCode
 792         - errorMessage
 793       properties:
 794         errorCode:
 795           type: string
 796           description: '401 - corrupted json, 402 - validation error, 501 - internal problem'
 797         errorMessage:
 798           type: string
 799           description: Human readable text