X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=Swagger%2FE2Manager_API.yaml;h=317a72a51707d5ce21373d972356f335f6900203;hb=0fb24ff00209041b316352327e2c73b699943131;hp=7e0dd20d30271bbc579fc56a4f4997e6dad4b4ed;hpb=13fff61e6062b16507c6419d3db7a293c50f6225;p=ric-plt%2Fe2mgr.git diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2Manager_API.yaml index 7e0dd20..317a72a 100644 --- a/Swagger/E2Manager_API.yaml +++ b/Swagger/E2Manager_API.yaml @@ -1,8 +1,25 @@ +# ================================================================================== +# Copyright (c) 2019-2020 Nokia +# Copyright (c) 2018-2020 AT&T Intellectual Property. +# Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved. +# +# 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. +# ================================================================================== openapi: 3.0.0 info: title: E2 Manager Service description: E2 Manager Service APIs - version: 5.2.8 + version: 5.4.5 servers: - url: 'http://{apiRoot}/v1' variables: @@ -28,7 +45,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 +64,93 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - '/nodeb/{ranName}/update': + /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' + + '/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 +158,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateGnbResponse' + $ref: '#/components/schemas/NodebResponse' '400': description: Invalid input content: @@ -85,17 +171,24 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - '/nodeb/enb': - post: - summary: Add ENB + '/nodeb/gnb/{ranName}': + put: + summary: Update gNB Cells 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 +196,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddEnbResponse' + $ref: '#/components/schemas/NodebResponse' '400': description: Invalid input content: @@ -116,7 +209,37 @@ paths: 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: RAN 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/shutdown: put: tags: @@ -137,7 +260,7 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/ids: + /nodeb/states: get: tags: - nodeb @@ -158,6 +281,37 @@ 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 @@ -219,64 +373,6 @@ paths: $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 +381,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: @@ -338,41 +408,12 @@ components: type: object 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: + healthCheckTimestampSent: + type: integer + healthCheckTimestampReceived: type: integer - ranName: - type: string - setupFailure: - $ref: '#/components/schemas/SetupFailure' - additionalProperties: false type: object ErrorResponse: type: object @@ -601,6 +642,10 @@ components: type: object Gnb: properties: + gnbType: + oneOf: + - type: string + - type: integer servedNrCells: $ref: '#/components/schemas/ServedNrCells' ranFunctions: @@ -1009,6 +1054,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: @@ -1027,4 +1094,41 @@ components: type: number sectorId: type: integer - type: object \ No newline at end of file + 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' + setupFromNetwork: + type: boolean + additionalProperties: false + type: object