X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=Swagger%2FE2Manager_API.yaml;h=317a72a51707d5ce21373d972356f335f6900203;hb=993cf6b75fb2ae84dd4e04e8ab7aa79a62b63095;hp=2b765a06b5f409cf22d035b091a148515da10897;hpb=49144464f0450ce157a716010cbbd7c3143d332f;p=ric-plt%2Fe2mgr.git diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2Manager_API.yaml index 2b765a0..317a72a 100644 --- a/Swagger/E2Manager_API.yaml +++ b/Swagger/E2Manager_API.yaml @@ -1,30 +1,25 @@ -# ========================LICENSE_START================================= -# O-RAN-SC +# ================================================================================== +# Copyright (c) 2019-2020 Nokia +# Copyright (c) 2018-2020 AT&T Intellectual Property. +# Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved. # -# 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 # -# 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 # -# 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). - - +# 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. +# ================================================================================== openapi: 3.0.0 info: title: E2 Manager Service description: E2 Manager Service APIs - version: 4.0.0 + version: 5.4.5 servers: - url: 'http://{apiRoot}/v1' variables: @@ -32,23 +27,54 @@ servers: default: 'localhost:3800' paths: '/nodeb/{ranName}': - put: - summary: Update GNB + get: tags: - nodeb - operationId: UpdateGnb + summary: Get RAN by name + operationId: getNb parameters: - name: ranName in: path required: true - description: Name of GNB RAN to update + description: Name of RAN to return schema: type: string + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/NodebResponse' + '400': + 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 + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /nodeb/enb: + post: + summary: Add eNB + tags: + - nodeb + operationId: AddEnb requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateGnbRequest' + $ref: '#/components/schemas/AddEnbRequest' required: true responses: '200': @@ -56,7 +82,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateGnbResponse' + $ref: '#/components/schemas/NodebResponse' '400': description: Invalid input content: @@ -69,39 +95,141 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - '503': - description: Routing Manager Unavailable + + '/nodeb/enb/{ranName}': + delete: + tags: + - nodeb + summary: Delete eNB + operationId: DeleteEnb + parameters: + - name: ranName + in: path + required: true + description: Name of RAN to delete + schema: + type: string + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/NodebResponse' + '400': + description: The specified RAN is not ENB + 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' - get: + '500': + description: Internal Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' + put: tags: - nodeb - summary: Get RAN by name - operationId: getNb + summary: Update eNB + operationId: UpdateEnb parameters: - name: ranName in: path required: true - description: Name of RAN to return + 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/GetNodebResponse' + $ref: '#/components/schemas/NodebResponse' '400': - description: The specified RAN name is invalid + 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/health: + put: + tags: + - nodeb + summary: E2 manager is requested to check connectivity with all E2 nodes or a list of E2 nodes + requestBody: + content: + application/json: + schema: + type: object + properties: + ranList: + type: array + items: + type: string + required: false + responses: + '202': + description: 'Request accepted' '404': - description: A RAN with the specified name was not found + description: RAN not found content: application/problem+json: schema: @@ -111,7 +239,7 @@ paths: content: application/problem+json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/ErrorResponse' /nodeb/shutdown: put: tags: @@ -132,7 +260,7 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/ids: + /nodeb/states: get: tags: - nodeb @@ -153,6 +281,68 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' + '/nodeb/states/{ranName}': + get: + summary: E2 manager is requested to report the health status of the connection to the E2 node + tags: + - nodeb + parameters: + - name: ranName + in: path + required: true + description: Name of RAN to get Health check + schema: + type: string + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/NodebIdentity' + '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/parameters: + put: + summary: Update e2mgr configuration + tags: + - nodeb + operationId: SetConfiguration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetConfiguration' + required: true + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/SetConfiguration' + '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' /health: get: tags: @@ -185,1196 +375,475 @@ components: schemas: UpdateGnbRequest: type: object + required: + - servedNrCells properties: - gnb: - properties: - servedNrCells: - items: - properties: - nrNeighbourInfos: - items: - properties: - choiceNrMode: - properties: - fdd: - properties: - dlarFcnFreqInfo: - 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 - 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: - 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: - 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: - 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: - properties: - cellId: - type: string - choiceNrMode: - properties: - fdd: - 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: - 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: - - type: string - - type: integer - nrscs: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalProperties: false - type: object - 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: - 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: - 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 - configuredStac: - type: string - nrMode: - oneOf: - - type: string - - type: integer - nrPci: - type: integer - servedPlmns: - items: - type: string - type: array - stac5g: - type: string - additionalProperties: false - type: object - additionalProperties: false - type: object - type: array - ranFunctions: - items: - properties: - ranFunctionId: - type: integer - ranFunctionDefinition: - type: string - ranFunctionRevision: - type: integer - additionalProperties: false - type: object - type: array - additionalProperties: false - type: object - additionalProperties: false - UpdateGnbResponse: - properties: - connectionStatus: - oneOf: - - type: string - - type: integer - failureType: - oneOf: - - type: string - - type: integer - globalNbId: + servedNrCells: + $ref: '#/components/schemas/ServedNrCells' + additionalProperties: false + UpdateEnbRequest: + type: object + required: + - enb + properties: + enb: + $ref: '#/components/schemas/Enb' + additionalProperties: false + SetConfiguration: + type: object + required: + - enableRic + properties: + enableRic: + type: boolean + additionalProperties: false + NodebIdentity: + properties: + globalNbId: properties: nbId: type: string plmnId: type: string - additionalProperties: false - type: object - gnb: - properties: - servedNrCells: - items: - properties: - nrNeighbourInfos: - items: - properties: - choiceNrMode: - properties: - fdd: - properties: - dlarFcnFreqInfo: - 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 - 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: - 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: - 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: - 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: - properties: - cellId: - type: string - choiceNrMode: - properties: - fdd: - 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: - 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: - - type: string - - type: integer - nrscs: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalProperties: false - type: object - 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: - 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: - 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 - configuredStac: - type: string - nrMode: - oneOf: - - type: string - - type: integer - nrPci: - type: integer - servedPlmns: - items: - type: string - type: array - stac5g: - type: string - additionalProperties: false - type: object - additionalProperties: false - type: object - type: array - ranFunctions: - items: - properties: - ranFunctionId: - type: integer - ranFunctionDefinition: - type: string - ranFunctionRevision: - type: integer - additionalProperties: false - type: object - type: array - additionalProperties: false type: object - ip: + inventoryName: type: string - nodeType: + connectionStatus: + type: string + healthCheckTimestampSent: + type: integer + healthCheckTimestampReceived: + type: integer + type: object + ErrorResponse: + type: object + required: + - errorCode + - errorMessage + properties: + 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 - port: - type: integer - ranName: - type: string - setupFailure: - properties: - criticalityDiagnostics: - properties: - informationElementCriticalityDiagnostics: - 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 + choiceEutraMode: + properties: + fdd: properties: - ieCriticality: + dlTransmissionBandwidth: oneOf: - type: string - type: integer - ieId: + dlearFcn: type: integer - typeOfError: + ulTransmissionBandwidth: oneOf: - type: string - type: integer + ulearFcn: + 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: - oneOf: - - type: string - - type: integer - transportLayerCause: - oneOf: - - type: string - - type: integer - additionalProperties: false - type: object - additionalProperties: false - type: object - NodebIdentity: - properties: - globalNbId: - properties: - nbId: - type: string - plmnId: - type: string - type: object - inventoryName: - type: string - type: object - GetNodebResponse: - properties: - connectionStatus: - oneOf: - - type: string - - type: integer - enb: - properties: - enbType: - oneOf: - - type: string - - type: integer - guGroupIds: - items: - type: string - type: array - servedCells: - items: - properties: - bandwidthReducedSi: - oneOf: - - type: string - - type: integer - broadcastPlmns: - items: - type: string - type: array - cellId: - type: string - choiceEutraMode: + 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 + 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 - transmissionBandwidth: + 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 - csgId: - type: string - eutraMode: - oneOf: - - type: string - - type: integer - freqBandIndicatorPriority: - oneOf: - - type: string - - type: integer - mbmsServiceAreaIdentities: - items: + 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 - 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: + subframeAllocationType: + oneOf: + - type: string + - type: integer + additionalProperties: false + type: object + type: array + multibandInfos: + items: + type: integer + type: array + neighbourInfos: + items: + properties: + earFcn: 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: + 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: type: integer - prachConfiguration: - properties: - highSpeedFlag: - type: boolean - prachConfigurationIndex: - type: integer - prachFrequencyOffset: - type: integer - rootSequenceIndex: - type: integer - zeroCorrelationZoneConfiguration: - type: integer - additionalProperties: false - type: object - tac: - type: string - additionalProperties: false type: object - type: array - additionalProperties: false - type: object - failureType: + tac: + type: string + additionalCellInformation: + $ref: '#/components/schemas/AdditionalCellInformation' + type: object + type: array + type: object + Gnb: + properties: + gnbType: oneOf: - type: string - type: integer - globalNbId: - properties: - nbId: - type: string - plmnId: - type: string - additionalProperties: false - type: object - gnb: - properties: - servedNrCells: - items: - properties: - nrNeighbourInfos: - items: + 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: + 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: + 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 + 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: - dlarFcnFreqInfo: - 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 - ularFcnFreqInfo: + 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 - 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: - properties: - arFcnNrFreqInfo: - properties: - frequencyBands: - items: - properties: - nrFrequencyBand: - type: integer - supportedSulBands: - items: - type: integer - type: array - additionalProperties: false - type: object - type: array - nrArFcn: + 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: @@ -1386,45 +855,45 @@ components: - 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: @@ -1438,47 +907,47 @@ components: 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: @@ -1494,149 +963,172 @@ components: 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 - ranFunctions: + 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: + informationElementCriticalityDiagnostics: items: properties: - ranFunctionId: - type: integer - ranFunctionDefinition: - type: string - ranFunctionRevision: + ieCriticality: + oneOf: + - type: string + - type: integer + ieId: type: integer + typeOfError: + oneOf: + - type: string + - type: integer 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: - 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: + 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: - 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: + ranName: type: string - description: Human readable text - RedButtonPartialSuccessResponseModel: - type: object - required: - - message - properties: - message: + globalNbId: + properties: + nbId: + type: string + plmnId: + type: string + ip: type: string - description: Partial success reason - 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 + setupFailure: + $ref: '#/components/schemas/SetupFailure' + setupFromNetwork: + type: boolean + additionalProperties: false + type: object