X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=Swagger%2FE2Manager_API.yaml;h=317a72a51707d5ce21373d972356f335f6900203;hb=e5480be0d39eb6a49a6f021a27665ef447523145;hp=b8b6dbd62186e9416e443984165daa980b2c66b6;hpb=e244cfd2647dee26f9e49b01dbd3daa8b5d72f0a;p=ric-plt%2Fe2mgr.git diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2Manager_API.yaml index b8b6dbd..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.18 + version: 5.4.5 servers: - url: 'http://{apiRoot}/v1' variables: @@ -47,11 +64,43 @@ 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' + '/nodeb/enb/{ranName}': delete: tags: - nodeb - summary: Delete ENB + summary: Delete eNB operationId: DeleteEnb parameters: - name: ranName @@ -88,7 +137,7 @@ paths: put: tags: - nodeb - summary: Update ENB + summary: Update eNB operationId: UpdateEnb parameters: - name: ranName @@ -122,9 +171,9 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - '/nodeb/{ranName}/update': + '/nodeb/gnb/{ranName}': put: - summary: Update GNB + summary: Update gNB Cells tags: - nodeb operationId: UpdateGnb @@ -160,6 +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: @@ -201,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 @@ -260,37 +371,6 @@ 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: UpdateGnbRequest: @@ -328,6 +408,12 @@ components: type: object inventoryName: type: string + connectionStatus: + type: string + healthCheckTimestampSent: + type: integer + healthCheckTimestampReceived: + type: integer type: object ErrorResponse: type: object @@ -556,6 +642,10 @@ components: type: object Gnb: properties: + gnbType: + oneOf: + - type: string + - type: integer servedNrCells: $ref: '#/components/schemas/ServedNrCells' ranFunctions: @@ -1038,5 +1128,7 @@ components: type: string setupFailure: $ref: '#/components/schemas/SetupFailure' + setupFromNetwork: + type: boolean additionalProperties: false - type: object \ No newline at end of file + type: object