X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=Swagger%2FE2M_API_2020-04-22.yaml;fp=Swagger%2FE2Manager_API.yaml;h=bcc1e84977a868ed44d5a6f021bb28e28d280e92;hb=refs%2Fchanges%2F83%2F3383%2F1;hp=2b765a06b5f409cf22d035b091a148515da10897;hpb=3ae760f4378ea43575eca6e83ccc01084566e7cf;p=ric-plt%2Fe2mgr.git diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2M_API_2020-04-22.yaml old mode 100644 new mode 100755 similarity index 97% rename from Swagger/E2Manager_API.yaml rename to Swagger/E2M_API_2020-04-22.yaml index 2b765a0..bcc1e84 --- a/Swagger/E2Manager_API.yaml +++ b/Swagger/E2M_API_2020-04-22.yaml @@ -1,25 +1,3 @@ -# ========================LICENSE_START================================= -# O-RAN-SC -# -# Copyright (C) 2019 AT&T Intellectual Property and Nokia -# -# 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. -# ========================LICENSE_END=================================== - -# This source code is part of the near-RT RIC (RAN Intelligent Controller) -# platform project (RICP). - - openapi: 3.0.0 info: title: E2 Manager Service @@ -32,87 +10,83 @@ servers: default: 'localhost:3800' paths: '/nodeb/{ranName}': - put: - summary: Update GNB + get: tags: - nodeb - operationId: UpdateGnb + summary: Get RAN by name + operationId: getNb parameters: - name: ranName in: path required: true - description: Name of GNB RAN to update + description: Name of RAN to return schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateGnbRequest' - required: true responses: '200': description: Successful operation content: application/json: schema: - $ref: '#/components/schemas/UpdateGnbResponse' + $ref: '#/components/schemas/GetNodebResponse' '400': - description: Invalid input + description: The specified RAN name is invalid content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ErrorResponse' - '500': - description: Internal error + '404': + description: A RAN with the specified name was not found content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - '503': - description: Routing Manager Unavailable + '500': + description: Internal Error content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - get: + '/nodeb/{ranName}/update': + put: + summary: Update GNB tags: - nodeb - summary: Get RAN by name - operationId: getNb + operationId: UpdateGnb parameters: - name: ranName in: path required: true - description: Name of RAN to return + description: Name of GNB RAN to update schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateGnbRequest' + required: true responses: '200': description: Successful operation content: application/json: schema: - $ref: '#/components/schemas/GetNodebResponse' + $ref: '#/components/schemas/UpdateGnbResponse' '400': - description: The specified RAN name is invalid - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - '404': - description: A RAN with the specified name was not found + description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' '500': - description: Internal Error + description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/shutdown: + + '/nodeb/shutdown': put: tags: - nodeb @@ -132,7 +106,7 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /nodeb/ids: + '/nodeb/ids': get: tags: - nodeb @@ -153,7 +127,7 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ErrorResponse' - /health: + '/health': get: tags: - Health Check @@ -161,7 +135,7 @@ paths: responses: '200': description: OK - /e2t/list: + '/e2t/list': get: tags: - e2t @@ -185,14 +159,21 @@ components: schemas: UpdateGnbRequest: type: object + required: + - servedNrCells properties: - gnb: - properties: servedNrCells: items: + required: + - servedNrCellInformation properties: nrNeighbourInfos: items: + required: + - choiceNrMode + - nrCgi + - nrMode + - nrPci properties: choiceNrMode: properties: @@ -336,6 +317,12 @@ components: type: object type: array servedNrCellInformation: + required: + - cellId + - choiceNrMode + - nrMode + - nrPci + - servedPlmns properties: cellId: type: string @@ -520,20 +507,6 @@ components: 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: