X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=Swagger%2FE2Manager_API.yaml;h=317a72a51707d5ce21373d972356f335f6900203;hb=a8eaf55eb9612967a2e217f9494736e9ef89b113;hp=1bab2f6ed6789b3da2ae2d94feb3e6b3bee3ff72;hpb=3bb8346d53a5ab8378adb4bee41f49fd445f6cd5;p=ric-plt%2Fe2mgr.git diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2Manager_API.yaml index 1bab2f6..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.21 + version: 5.4.5 servers: - url: 'http://{apiRoot}/v1' variables: @@ -192,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: @@ -233,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 @@ -329,6 +408,12 @@ components: type: object inventoryName: type: string + connectionStatus: + type: string + healthCheckTimestampSent: + type: integer + healthCheckTimestampReceived: + type: integer type: object ErrorResponse: type: object