X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=Swagger%2FE2Manager_API.yaml;h=bb8b7fcdb0f243994a3a325853274d02298de4f8;hb=74f9752fae845468e4f8948265c892fa8fe9fdb7;hp=e5476f0d3689d383b59567112d225ee42f061cc6;hpb=e611aee31f24b6944597fa3725a23b762716f305;p=ric-plt%2Fe2mgr.git diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2Manager_API.yaml index e5476f0..bb8b7fc 100644 --- a/Swagger/E2Manager_API.yaml +++ b/Swagger/E2Manager_API.yaml @@ -1,101 +1,95 @@ -# ========================LICENSE_START================================= -# O-RAN-SC -# -# Copyright (C) 2019 AT&T Intellectual Property and Nokia -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ========================LICENSE_END=================================== - -# This source code is part of the near-RT RIC (RAN Intelligent Controller) -# platform project (RICP). - - openapi: 3.0.0 info: title: E2 Manager Service description: E2 Manager Service APIs - version: 3.0.3 + version: 5.2.20 servers: - url: 'http://{apiRoot}/v1' variables: apiRoot: default: 'localhost:3800' paths: - /nodeb/x2-setup: - post: - summary: X2 Setup + '/nodeb/{ranName}': + get: tags: - nodeb - operationId: x2Setup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetupRequest' - required: true + summary: Get RAN by name + operationId: getNb + parameters: + - name: ranName + in: path + required: true + description: Name of RAN to return + schema: + type: string responses: '200': - description: Success + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/NodebResponse' '400': - description: Invalid input + description: The specified RAN name is invalid + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: A RAN with the specified name was not found content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' '500': - description: Internal error + description: Internal Error content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/endc-setup: + /nodeb/enb: post: + summary: Add eNB tags: - nodeb - summary: ENDC Setup - operationId: endcSetup + operationId: AddEnb requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetupRequest' + $ref: '#/components/schemas/AddEnbRequest' required: true responses: '200': - description: Success + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/NodebResponse' '400': description: Invalid input content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' '500': - description: Internal Error + description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - '/nodeb/{ranName}': - get: + + '/nodeb/enb/{ranName}': + delete: tags: - nodeb - summary: Get RAN by name - operationId: getNb + summary: Delete eNB + operationId: DeleteEnb parameters: - name: ranName in: path required: true - description: Name of RAN to return + description: Name of RAN to delete schema: type: string responses: @@ -104,9 +98,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetNodebResponse' + $ref: '#/components/schemas/NodebResponse' '400': - description: The specified RAN name is invalid + description: The specified RAN is not ENB content: application/json: schema: @@ -123,13 +117,93 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' + put: + tags: + - nodeb + summary: Update eNB + operationId: UpdateEnb + parameters: + - name: ranName + in: path + required: true + description: Name of ENB ran to update + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateEnbRequest' + required: true + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/NodebResponse' + '400': + description: Invalid input + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/nodeb/gnb/{ranName}': + put: + summary: Update gNB Cells + tags: + - nodeb + operationId: UpdateGnb + parameters: + - name: ranName + in: path + required: true + description: Name of GNB RAN to update + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateGnbRequest' + required: true + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/NodebResponse' + '400': + description: Invalid input + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' /nodeb/shutdown: put: tags: - nodeb - summary: >- - Close all connections to the RANs + summary: Close all connections to the RANs responses: + '200': + description: 'Operation succeeded internally, outbound calls failed' + content: + application/json: + schema: + $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel' '204': description: Successful operation '500': @@ -138,7 +212,7 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/ids: + /nodeb/states: get: tags: - nodeb @@ -159,48 +233,37 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/{ranName}/reset: + /nodeb/parameters: put: + summary: Update e2mgr configuration tags: - nodeb - summary: >- - Upon receipt of this message, 'ranName' shall abort any other ongoing procedures over X2 between the RIC and the RAN. The RAN shall delete all the context information related to the RIC, except the application level configuration data exchanged during the X2 Setup or eNB Configuration Update procedures, and release the corresponding resource. - operationId: reset - parameters: - - name: ranName - in: path - required: true - description: Name of RAN to return - schema: - type: string + operationId: SetConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResetRequest' - required: false + $ref: '#/components/schemas/SetConfiguration' + required: true responses: - '204': + '200': description: Successful operation - '400': - description: Invalid input (invalid cause, RAN in wrong state) content: - application/problem+json: + application/json: schema: - $ref: '#/components/schemas/ErrorResponse' - '404': - description: A RAN with the specified name was not found + $ref: '#/components/schemas/SetConfiguration' + '400': + description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' '500': - description: Internal Error + description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /health: get: tags: @@ -231,92 +294,30 @@ paths: $ref: '#/components/schemas/ErrorResponse' components: schemas: - SetupRequest: + UpdateGnbRequest: type: object required: - - ranIp - - ranPort - - ranName + - servedNrCells properties: - ranIp: - type: string - ranPort: - type: integer - format: uint16 - ranName: - type: string - ResetRequest: + servedNrCells: + $ref: '#/components/schemas/ServedNrCells' + additionalProperties: false + UpdateEnbRequest: type: object required: - - cause + - enb properties: - cause: - type: string - enum: [misc:control-processing-overload, -misc:hardware-failure, -misc:om-intervention, -misc:not-enough-user-plane-processing-resources, -misc:unspecified, -protocol:transfer-syntax-error, -protocol:abstract-syntax-error-reject, -protocol:abstract-syntax-error-ignore-and-notify, -protocol:message-not-compatible-with-receiver-state, -protocol:semantic-error, -protocol:unspecified, -protocol:abstract-syntax-error-falsely-constructed-message, -transport:transport-resource-unavailable, -transport:unspecified, -radioNetwork:handover-desirable-for-radio-reasons, -radioNetwork:time-critical-handover, -radioNetwork:resource-optimisation-handover, -radioNetwork:reduce-load-in-serving-cell, -radioNetwork:partial-handover, -radioNetwork:unknown-new-eNB-UE-X2AP-ID, -radioNetwork:unknown-old-eNB-UE-X2AP-ID, -radioNetwork:unknown-pair-of-UE-X2AP-ID, -radioNetwork:ho-target-not-allowed, -radioNetwork:tx2relocoverall-expiry, -radioNetwork:trelocprep-expiry, -radioNetwork:cell-not-available, -radioNetwork:no-radio-resources-available-in-target-cell, -radioNetwork:invalid-MME-GroupID, -radioNetwork:unknown-MME-Code, -radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported, -radioNetwork:reportCharacteristicsEmpty, -radioNetwork:noReportPeriodicity, -radioNetwork:existingMeasurementID, -radioNetwork:unknown-eNB-Measurement-ID, -radioNetwork:measurement-temporarily-not-available, -radioNetwork:unspecified, -radioNetwork:load-balancing, -radioNetwork:handover-optimisation, -radioNetwork:value-out-of-allowed-range, -radioNetwork:multiple-E-RAB-ID-instances, -radioNetwork:switch-off-ongoing, -radioNetwork:not-supported-QCI-value, -radioNetwork:measurement-not-supported-for-the-object, -radioNetwork:tDCoverall-expiry, -radioNetwork:tDCprep-expiry, -radioNetwork:action-desirable-for-radio-reasons, -radioNetwork:reduce-load, -radioNetwork:resource-optimisation, -radioNetwork:time-critical-action, -radioNetwork:target-not-allowed, -radioNetwork:no-radio-resources-available, -radioNetwork:invalid-QoS-combination, -radioNetwork:encryption-algorithms-not-aupported, -radioNetwork:procedure-cancelled, -radioNetwork:rRM-purpose, -radioNetwork:improve-user-bit-rate, -radioNetwork:user-inactivity, -radioNetwork:radio-connection-with-UE-lost, -radioNetwork:failure-in-the-radio-interface-procedure, -radioNetwork:bearer-option-not-supported, -radioNetwork:mCG-Mobility, -radioNetwork:sCG-Mobility, -radioNetwork:count-reaches-max-value, -radioNetwork:unknown-old-en-gNB-UE-X2AP-ID, -radioNetwork:pDCP-Overload] + enb: + $ref: '#/components/schemas/Enb' + additionalProperties: false + SetConfiguration: + type: object + required: + - enableRic + properties: + enableRic: + type: boolean + additionalProperties: false NodebIdentity: properties: globalNbId: @@ -329,402 +330,431 @@ radioNetwork:pDCP-Overload] inventoryName: type: string type: object - GetNodebResponse: + ErrorResponse: + type: object + required: + - errorCode + - errorMessage properties: - connectionStatus: + errorCode: + type: string + description: >- + 401 - corrupted json, 402 - validation error, 403 - RAN in wrong + state, 404 - resource not found, 500 - RNIB error, 501 - internal + problem, 502 - RMR error, 503 - Routing Manager Unavailable + errorMessage: + type: string + description: Human readable text + RedButtonPartialSuccessResponseModel: + type: object + required: + - message + properties: + message: + type: string + description: Partial success reason + E2tIdentity: + type: object + required: + - e2tAddress + - ranNames + properties: + e2tAddress: + type: string + ranNames: + items: + type: string + type: array + RanFunction: + properties: + ranFunctionId: + type: integer + ranFunctionDefinition: + type: string + ranFunctionRevision: + type: integer + type: object + Enb: + properties: + enbType: oneOf: - type: string - type: integer - enb: - properties: - enbType: - oneOf: - - type: string - - type: integer - guGroupIds: - items: + guGroupIds: + items: + type: string + type: array + servedCells: + items: + properties: + bandwidthReducedSi: + oneOf: + - type: string + - type: integer + broadcastPlmns: + items: + type: string + type: array + cellId: type: string - type: array - servedCells: - items: + choiceEutraMode: properties: - bandwidthReducedSi: - oneOf: - - type: string - - type: integer - broadcastPlmns: - items: - type: string - type: array - cellId: - type: string - choiceEutraMode: + fdd: + properties: + dlTransmissionBandwidth: + oneOf: + - type: string + - type: integer + dlearFcn: + type: integer + ulTransmissionBandwidth: + oneOf: + - type: string + - type: integer + ulearFcn: + type: integer + additionalProperties: false + type: object + tdd: properties: - fdd: + additionalSpecialSubframeExtensionInfo: properties: - dlTransmissionBandwidth: + additionalSpecialSubframePatternsExtension: + oneOf: + - type: string + - type: integer + cyclicPrefixDl: oneOf: - type: string - type: integer - dlearFcn: - type: integer - ulTransmissionBandwidth: + cyclicPrefixUl: oneOf: - type: string - type: integer - ulearFcn: - type: integer additionalProperties: false type: object - tdd: + additionalSpecialSubframeInfo: properties: - additionalSpecialSubframeExtensionInfo: - properties: - additionalSpecialSubframePatternsExtension: - oneOf: - - type: string - - type: integer - cyclicPrefixDl: - oneOf: - - type: string - - type: integer - cyclicPrefixUl: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalSpecialSubframeInfo: - properties: - additionalSpecialSubframePatterns: - oneOf: - - type: string - - type: integer - cyclicPrefixDl: - oneOf: - - type: string - - type: integer - cyclicPrefixUl: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - earFcn: - type: integer - specialSubframeInfo: - properties: - cyclicPrefixDl: - oneOf: - - type: string - - type: integer - cyclicPrefixUl: - oneOf: - - type: string - - type: integer - specialSubframePatterns: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - subframeAssignment: + additionalSpecialSubframePatterns: + oneOf: + - type: string + - type: integer + cyclicPrefixDl: oneOf: - type: string - type: integer - transmissionBandwidth: + cyclicPrefixUl: oneOf: - type: string - type: integer additionalProperties: false type: object - additionalProperties: false - type: object - csgId: - type: string - eutraMode: - oneOf: - - type: string - - type: integer - freqBandIndicatorPriority: - oneOf: - - type: string - - type: integer - mbmsServiceAreaIdentities: - items: - type: string - type: array - mbsfnSubframeInfos: - items: - properties: - radioframeAllocationOffset: - type: integer - radioframeAllocationPeriod: - oneOf: - - type: string - - type: integer - subframeAllocation: - type: string - subframeAllocationType: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - type: array - multibandInfos: - items: - type: integer - type: array - neighbourInfos: - items: - properties: - earFcn: - type: integer - ecgi: - type: string - pci: - type: integer - tac: - type: string - additionalProperties: false - type: object - type: array - numberOfAntennaPorts: - oneOf: - - type: string - - type: integer - pci: - type: integer - prachConfiguration: - properties: - highSpeedFlag: - type: boolean - prachConfigurationIndex: - type: integer - prachFrequencyOffset: - type: integer - rootSequenceIndex: - type: integer - zeroCorrelationZoneConfiguration: + earFcn: type: integer + specialSubframeInfo: + properties: + cyclicPrefixDl: + oneOf: + - type: string + - type: integer + cyclicPrefixUl: + oneOf: + - type: string + - type: integer + specialSubframePatterns: + oneOf: + - type: string + - type: integer + additionalProperties: false + type: object + subframeAssignment: + oneOf: + - type: string + - type: integer + transmissionBandwidth: + oneOf: + - type: string + - type: integer additionalProperties: false type: object - tac: - type: string additionalProperties: false type: object - type: array - additionalProperties: false - type: object - failureType: - oneOf: - - type: string - - type: integer - globalNbId: - properties: - nbId: - type: string - plmnId: - type: string - additionalProperties: false - type: object - gnb: - properties: - servedNrCells: - items: + csgId: + type: string + eutraMode: + oneOf: + - type: string + - type: integer + freqBandIndicatorPriority: + oneOf: + - type: string + - type: integer + mbmsServiceAreaIdentities: + items: + type: string + type: array + mbsfnSubframeInfos: + items: + properties: + radioframeAllocationOffset: + type: integer + radioframeAllocationPeriod: + oneOf: + - type: string + - type: integer + subframeAllocation: + type: string + subframeAllocationType: + oneOf: + - type: string + - type: integer + additionalProperties: false + type: object + type: array + multibandInfos: + items: + type: integer + type: array + neighbourInfos: + items: + properties: + earFcn: + type: integer + ecgi: + type: string + pci: + type: integer + tac: + type: string + additionalProperties: false + type: object + type: array + numberOfAntennaPorts: + oneOf: + - type: string + - type: integer + pci: + type: integer + prachConfiguration: properties: - nrNeighbourInfos: - items: + highSpeedFlag: + type: boolean + prachConfigurationIndex: + type: integer + prachFrequencyOffset: + type: integer + rootSequenceIndex: + type: integer + zeroCorrelationZoneConfiguration: + type: integer + type: object + tac: + type: string + additionalCellInformation: + $ref: '#/components/schemas/AdditionalCellInformation' + type: object + type: array + type: object + Gnb: + properties: + servedNrCells: + $ref: '#/components/schemas/ServedNrCells' + ranFunctions: + items: + $ref: '#/components/schemas/RanFunction' + type: array + type: object + ServedNrCells: + items: + required: + - servedNrCellInformation + properties: + nrNeighbourInfos: + items: + required: + - choiceNrMode + - nrCgi + - nrMode + - nrPci + properties: + choiceNrMode: + properties: + fdd: properties: - choiceNrMode: + dlarFcnFreqInfo: properties: - fdd: + frequencyBands: + items: + properties: + nrFrequencyBand: + type: integer + supportedSulBands: + items: + type: integer + type: array + additionalProperties: false + type: object + type: array + nrArFcn: + oneOf: + - type: integer + sulInformation: properties: - dlarFcnFreqInfo: + sulArFcn: + oneOf: + - type: integer + sulTransmissionBandwidth: properties: - frequencyBands: - items: - properties: - nrFrequencyBand: - type: integer - supportedSulBands: - items: - type: integer - type: array - additionalProperties: false - type: object - type: array - nrArFcn: + ncnrb: + oneOf: + - type: string + - type: integer + nrscs: oneOf: + - type: string - type: integer - sulInformation: - properties: - sulArFcn: - oneOf: - - type: integer - sulTransmissionBandwidth: - properties: - ncnrb: - oneOf: - - type: string - - type: integer - nrscs: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalProperties: false - type: object additionalProperties: false type: object - ularFcnFreqInfo: + additionalProperties: false + type: object + additionalProperties: false + type: object + ularFcnFreqInfo: + properties: + frequencyBands: + items: + properties: + nrFrequencyBand: + type: integer + supportedSulBands: + items: + type: integer + type: array + additionalProperties: false + type: object + type: array + nrArFcn: + oneOf: + - type: integer + sulInformation: + properties: + sulArFcn: + oneOf: + - type: integer + sulTransmissionBandwidth: properties: - frequencyBands: - items: - properties: - nrFrequencyBand: - type: integer - supportedSulBands: - items: - type: integer - type: array - additionalProperties: false - type: object - type: array - nrArFcn: + ncnrb: oneOf: + - type: string + - type: integer + nrscs: + oneOf: + - type: string - type: integer - sulInformation: - properties: - sulArFcn: - oneOf: - - type: integer - sulTransmissionBandwidth: - properties: - ncnrb: - oneOf: - - type: string - - type: integer - nrscs: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalProperties: false - type: object additionalProperties: false type: object additionalProperties: false type: object - tdd: + additionalProperties: false + type: object + additionalProperties: false + type: object + tdd: + properties: + arFcnNrFreqInfo: + properties: + frequencyBands: + items: + properties: + nrFrequencyBand: + type: integer + supportedSulBands: + items: + type: integer + type: array + additionalProperties: false + type: object + type: array + nrArFcn: + oneOf: + - type: integer + sulInformation: properties: - arFcnNrFreqInfo: + sulArFcn: + oneOf: + - type: integer + sulTransmissionBandwidth: properties: - frequencyBands: - items: - properties: - nrFrequencyBand: - type: integer - supportedSulBands: - items: - type: integer - type: array - additionalProperties: false - type: object - type: array - nrArFcn: + ncnrb: + oneOf: + - type: string + - type: integer + nrscs: oneOf: + - type: string - type: integer - sulInformation: - properties: - sulArFcn: - oneOf: - - type: integer - sulTransmissionBandwidth: - properties: - ncnrb: - oneOf: - - type: string - - type: integer - nrscs: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalProperties: false - type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false type: object - configuredStac: - type: string - nrCgi: - type: string - nrMode: - oneOf: - - type: string - - type: integer - nrPci: - type: integer - stac5g: - type: string additionalProperties: false type: object - type: array - servedNrCellInformation: + additionalProperties: false + type: object + configuredStac: + type: string + nrCgi: + type: string + nrMode: + oneOf: + - type: string + - type: integer + nrPci: + type: integer + stac5g: + type: string + additionalProperties: false + type: object + type: array + servedNrCellInformation: + required: + - cellId + - choiceNrMode + - nrMode + - nrPci + - servedPlmns + properties: + cellId: + type: string + choiceNrMode: + properties: + fdd: properties: - cellId: - type: string - choiceNrMode: + dlFreqInfo: properties: - fdd: + frequencyBands: + items: + properties: + nrFrequencyBand: + type: integer + supportedSulBands: + items: + type: integer + type: array + additionalProperties: false + type: object + type: array + nrArFcn: + oneOf: + - type: integer + sulInformation: properties: - dlFreqInfo: - properties: - frequencyBands: - items: - properties: - nrFrequencyBand: - type: integer - supportedSulBands: - items: - type: integer - type: array - additionalProperties: false - type: object - type: array - nrArFcn: - oneOf: - - type: integer - sulInformation: - properties: - sulArFcn: - oneOf: - - type: integer - sulTransmissionBandwidth: - properties: - ncnrb: - oneOf: - - type: string - - type: integer - nrscs: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalProperties: false - type: object - additionalProperties: false - type: object - dlTransmissionBandwidth: + sulArFcn: + oneOf: + - type: integer + sulTransmissionBandwidth: properties: ncnrb: oneOf: @@ -736,45 +766,45 @@ radioNetwork:pDCP-Overload] - type: integer additionalProperties: false type: object - ulFreqInfo: - properties: - frequencyBands: - items: - properties: - nrFrequencyBand: - type: integer - supportedSulBands: - items: - type: integer - type: array - additionalProperties: false - type: object - type: array - nrArFcn: - oneOf: - - type: integer - sulInformation: - properties: - sulArFcn: - oneOf: - - type: integer - sulTransmissionBandwidth: - properties: - ncnrb: - oneOf: - - type: string - - type: integer - nrscs: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalProperties: false - type: object - additionalProperties: false - type: object - ulTransmissionBandwidth: + additionalProperties: false + type: object + additionalProperties: false + type: object + dlTransmissionBandwidth: + properties: + ncnrb: + oneOf: + - type: string + - type: integer + nrscs: + oneOf: + - type: string + - type: integer + additionalProperties: false + type: object + ulFreqInfo: + properties: + frequencyBands: + items: + properties: + nrFrequencyBand: + type: integer + supportedSulBands: + items: + type: integer + type: array + additionalProperties: false + type: object + type: array + nrArFcn: + oneOf: + - type: integer + sulInformation: + properties: + sulArFcn: + oneOf: + - type: integer + sulTransmissionBandwidth: properties: ncnrb: oneOf: @@ -788,47 +818,47 @@ radioNetwork:pDCP-Overload] type: object additionalProperties: false type: object - tdd: + additionalProperties: false + type: object + ulTransmissionBandwidth: + properties: + ncnrb: + oneOf: + - type: string + - type: integer + nrscs: + oneOf: + - type: string + - type: integer + additionalProperties: false + type: object + additionalProperties: false + type: object + tdd: + properties: + nrFreqInfo: + properties: + frequencyBands: + items: + properties: + nrFrequencyBand: + type: integer + supportedSulBands: + items: + type: integer + type: array + additionalProperties: false + type: object + type: array + nrArFcn: + oneOf: + - type: integer + sulInformation: properties: - nrFreqInfo: - properties: - frequencyBands: - items: - properties: - nrFrequencyBand: - type: integer - supportedSulBands: - items: - type: integer - type: array - additionalProperties: false - type: object - type: array - nrArFcn: - oneOf: - - type: integer - sulInformation: - properties: - sulArFcn: - oneOf: - - type: integer - sulTransmissionBandwidth: - properties: - ncnrb: - oneOf: - - type: string - - type: integer - nrscs: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalProperties: false - type: object - additionalProperties: false - type: object - transmissionBandwidth: + sulArFcn: + oneOf: + - type: integer + sulTransmissionBandwidth: properties: ncnrb: oneOf: @@ -844,126 +874,170 @@ radioNetwork:pDCP-Overload] type: object additionalProperties: false type: object - configuredStac: - type: string - nrMode: - oneOf: - - type: string - - type: integer - nrPci: - type: integer - servedPlmns: - items: - type: string - type: array - stac5g: - type: string + transmissionBandwidth: + properties: + ncnrb: + oneOf: + - type: string + - type: integer + nrscs: + oneOf: + - type: string + - type: integer + additionalProperties: false + type: object additionalProperties: false type: object additionalProperties: false type: object - type: array - additionalProperties: false - type: object - ip: - type: string - nodeType: - oneOf: - - type: string - - type: integer - port: - type: integer - ranName: - type: string - setupFailure: + configuredStac: + type: string + nrMode: + oneOf: + - type: string + - type: integer + nrPci: + type: integer + servedPlmns: + items: + type: string + type: array + stac5g: + type: string + additionalCellInformation: + $ref: '#/components/schemas/AdditionalCellInformation' + additionalProperties: false + type: object + additionalProperties: false + type: object + type: array + SetupFailure: + properties: + criticalityDiagnostics: properties: - criticalityDiagnostics: - properties: - informationElementCriticalityDiagnostics: - items: - properties: - ieCriticality: - oneOf: - - type: string - - type: integer - ieId: - type: integer - typeOfError: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - type: array - procedureCode: - type: integer - procedureCriticality: - oneOf: - - type: string - - type: integer - triggeringMessage: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - miscellaneousCause: - oneOf: - - type: string - - type: integer - networkLayerCause: - oneOf: - - type: string - - type: integer - protocolCause: - oneOf: - - type: string - - type: integer - timeToWait: + informationElementCriticalityDiagnostics: + items: + properties: + ieCriticality: + oneOf: + - type: string + - type: integer + ieId: + type: integer + typeOfError: + oneOf: + - type: string + - type: integer + additionalProperties: false + type: object + type: array + procedureCode: + type: integer + procedureCriticality: oneOf: - type: string - type: integer - transportLayerCause: + triggeringMessage: oneOf: - type: string - type: integer additionalProperties: false type: object + miscellaneousCause: + oneOf: + - type: string + - type: integer + networkLayerCause: + oneOf: + - type: string + - type: integer + protocolCause: + oneOf: + - type: string + - type: integer + timeToWait: + oneOf: + - type: string + - type: integer + transportLayerCause: + oneOf: + - type: string + - type: integer additionalProperties: false type: object - ErrorResponse: + AddEnbRequest: type: object required: - - errorCode - - errorMessage + - ranName + - globalNbId + - enb properties: - errorCode: + ranName: type: string - description: '401 - corrupted json, 402 - validation error, 403 - RAN in wrong state, 404 - resource not found, 500 - RNIB error, 501 - internal problem, 502 - RMR error' - errorMessage: + globalNbId: + properties: + nbId: + type: string + plmnId: + type: string + ip: type: string - description: Human readable text - E2tIdentity: - type: object - required: - - e2tAddress - - ranNames + port: + type: integer + enb: + $ref: '#/components/schemas/Enb' + additionalProperties: false + AdditionalCellInformation: properties: - e2tAddress: - type: string - ranNames: - items: - type: string - type: array - E2tErrorResponse: + cellLatitude: + type: number + cellLongitude: + type: number + antennaHeight: + type: number + antennaAzimuthDirection: + type: number + antennaTiltAngle: + type: number + antennaMaxTransmit: + type: number + antennaMaxGain: + type: number + sectorId: + type: integer type: object - required: - - errorCode - - errorMessage + NodebResponse: properties: - errorCode: + connectionStatus: + oneOf: + - type: string + - type: integer + enb: + $ref: '#/components/schemas/Enb' + failureType: + oneOf: + - type: string + - type: integer + globalNbId: + properties: + nbId: + type: string + plmnId: + type: string + type: object + gnb: + $ref: '#/components/schemas/Gnb' + ip: type: string - description: '500 - RNIB error, 501 - internal problem' - errorMessage: + nodeType: + oneOf: + - type: string + - type: integer + port: + type: integer + ranName: type: string - description: Human readable text \ No newline at end of file + setupFailure: + $ref: '#/components/schemas/SetupFailure' + additionalProperties: false + type: object