X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=Swagger%2FE2Manager_API.yaml;h=b8b6dbd62186e9416e443984165daa980b2c66b6;hb=35c65f11141d339d6afc27ed35c6fc09d61b8a99;hp=285f2d8ff529dc6c538c0b8c3536f90dab6aedc1;hpb=611eba27c24f595a57f7c55068605a57788ead95;p=ric-plt%2Fe2mgr.git diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2Manager_API.yaml index 285f2d8..b8b6dbd 100644 --- a/Swagger/E2Manager_API.yaml +++ b/Swagger/E2Manager_API.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: E2 Manager Service description: E2 Manager Service APIs - version: 5.2.9 + version: 5.2.18 servers: - url: 'http://{apiRoot}/v1' variables: @@ -28,7 +28,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetNodebResponse' + $ref: '#/components/schemas/NodebResponse' '400': description: The specified RAN name is invalid content: @@ -47,24 +47,61 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - '/nodeb/{ranName}/update': + '/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' + '500': + description: Internal Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' put: - summary: Update GNB tags: - nodeb - operationId: UpdateGnb + summary: Update ENB + operationId: UpdateEnb parameters: - name: ranName in: path required: true - description: Name of GNB RAN to update + description: Name of ENB ran to update schema: type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateGnbRequest' + $ref: '#/components/schemas/UpdateEnbRequest' required: true responses: '200': @@ -72,7 +109,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateGnbResponse' + $ref: '#/components/schemas/NodebResponse' '400': description: Invalid input content: @@ -85,17 +122,24 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - '/nodeb/enb': - post: - summary: Add ENB + '/nodeb/{ranName}/update': + put: + summary: Update GNB tags: - nodeb - operationId: AddEnb + 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/AddEnbRequest' + $ref: '#/components/schemas/UpdateGnbRequest' required: true responses: '200': @@ -103,7 +147,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddEnbResponse' + $ref: '#/components/schemas/NodebResponse' '400': description: Invalid input content: @@ -116,7 +160,6 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/shutdown: put: tags: @@ -137,7 +180,7 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/ids: + /nodeb/states: get: tags: - nodeb @@ -217,66 +260,39 @@ paths: 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/AddEnbRequest' + 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' components: schemas: - AddEnbRequest: - type: object - required: - - ranName - - globalNbId - - enb - properties: - ranName: - type: string - globalNbId: - properties: - nbId: - type: string - plmnId: - type: string - ip: - type: string - port: - type: integer - enb: - $ref: '#/components/schemas/Enb' - additionalProperties: false - - AddEnbResponse: - 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 - enb: - $ref: '#/components/schemas/Enb' - ip: - type: string - nodeType: - oneOf: - - type: string - - type: integer - port: - type: integer - ranName: - type: string - setupFailure: - $ref: '#/components/schemas/SetupFailure' - additionalProperties: false - type: object - UpdateGnbRequest: type: object required: @@ -285,40 +301,14 @@ components: servedNrCells: $ref: '#/components/schemas/ServedNrCells' additionalProperties: false - UpdateGnbResponse: + UpdateEnbRequest: + type: object + required: + - enb 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: - $ref: '#/components/schemas/Gnb' - ip: - type: string - nodeType: - oneOf: - - type: string - - type: integer - port: - type: integer - ranName: - type: string - setupFailure: - $ref: '#/components/schemas/SetupFailure' + enb: + $ref: '#/components/schemas/Enb' additionalProperties: false - type: object SetConfiguration: type: object required: @@ -339,41 +329,6 @@ components: inventoryName: type: string type: object - GetNodebResponse: - properties: - 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 - nodeType: - oneOf: - - type: string - - type: integer - port: - type: integer - ranName: - type: string - setupFailure: - $ref: '#/components/schemas/SetupFailure' - additionalProperties: false - type: object ErrorResponse: type: object required: @@ -1009,6 +964,28 @@ components: - type: integer additionalProperties: false type: object + AddEnbRequest: + type: object + required: + - ranName + - globalNbId + - enb + properties: + ranName: + type: string + globalNbId: + properties: + nbId: + type: string + plmnId: + type: string + ip: + type: string + port: + type: integer + enb: + $ref: '#/components/schemas/Enb' + additionalProperties: false AdditionalCellInformation: properties: cellLatitude: @@ -1028,3 +1005,38 @@ components: sectorId: type: integer type: object + NodebResponse: + properties: + 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 + nodeType: + oneOf: + - type: string + - type: integer + port: + type: integer + ranName: + type: string + setupFailure: + $ref: '#/components/schemas/SetupFailure' + additionalProperties: false + type: object \ No newline at end of file