X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=Swagger%2FE2Manager_API.yaml;h=2b765a06b5f409cf22d035b091a148515da10897;hb=49144464f0450ce157a716010cbbd7c3143d332f;hp=e5476f0d3689d383b59567112d225ee42f061cc6;hpb=bab0331f8cadd92b24d30edbb0e63187af12e5f7;p=ric-plt%2Fe2mgr.git diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2Manager_API.yaml index e5476f0..2b765a0 100644 --- a/Swagger/E2Manager_API.yaml +++ b/Swagger/E2Manager_API.yaml @@ -24,28 +24,39 @@ openapi: 3.0.0 info: title: E2 Manager Service description: E2 Manager Service APIs - version: 3.0.3 + version: 4.0.0 servers: - url: 'http://{apiRoot}/v1' variables: apiRoot: default: 'localhost:3800' paths: - /nodeb/x2-setup: - post: - summary: X2 Setup + '/nodeb/{ranName}': + put: + summary: Update GNB tags: - nodeb - operationId: x2Setup + 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/SetupRequest' + $ref: '#/components/schemas/UpdateGnbRequest' required: true responses: '200': - description: Success + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateGnbResponse' '400': description: Invalid input content: @@ -58,34 +69,12 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/endc-setup: - post: - tags: - - nodeb - summary: ENDC Setup - operationId: endcSetup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetupRequest' - required: true - responses: - '200': - description: Success - '400': - description: Invalid input - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - '500': - description: Internal Error + '503': + description: Routing Manager Unavailable content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - '/nodeb/{ranName}': get: tags: - nodeb @@ -127,9 +116,14 @@ paths: 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': @@ -159,48 +153,6 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/{ranName}/reset: - put: - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ResetRequest' - required: false - responses: - '204': - description: Successful operation - '400': - description: Invalid input (invalid cause, RAN in wrong state) - content: - application/problem+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' - /health: get: tags: @@ -231,92 +183,790 @@ paths: $ref: '#/components/schemas/ErrorResponse' components: schemas: - SetupRequest: + UpdateGnbRequest: type: object - required: - - ranIp - - ranPort - - ranName properties: - ranIp: + 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: + 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: type: string - ranPort: + nodeType: + oneOf: + - type: string + - type: integer + port: type: integer - format: uint16 ranName: type: string - ResetRequest: + 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: + oneOf: + - type: string + - type: integer + transportLayerCause: + oneOf: + - type: string + - type: integer + additionalProperties: false + type: object + additionalProperties: false type: object - required: - - cause - 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] NodebIdentity: properties: globalNbId: @@ -863,6 +1513,18 @@ radioNetwork:pDCP-Overload] 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: @@ -939,10 +1601,21 @@ radioNetwork:pDCP-Overload] 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' + 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: @@ -966,4 +1639,4 @@ radioNetwork:pDCP-Overload] description: '500 - RNIB error, 501 - internal problem' errorMessage: type: string - description: Human readable text \ No newline at end of file + description: Human readable text