From 404259bbdeedbcbb45f4bf650f1a89c8707e740c Mon Sep 17 00:00:00 2001 From: "Lott, Christopher (cl778h)" Date: Thu, 9 May 2019 14:20:08 -0400 Subject: [PATCH] Update A1 mediator spec to ver 0.4.0 Change-Id: I414c76d3f91c8b558cdb8746680d21bdaf6d3bd9 Issue-Id: RICPLT-1202 Signed-off-by: Lott, Christopher (cl778h) --- a1-med-client/pom.xml | 4 +- .../src/main/resources/a1_mediator_0.4.0.yaml | 102 +++++++++++++++++++++ docs/release-notes.rst | 1 + webapp-backend/pom.xml | 2 +- 4 files changed, 106 insertions(+), 3 deletions(-) create mode 100644 a1-med-client/src/main/resources/a1_mediator_0.4.0.yaml diff --git a/a1-med-client/pom.xml b/a1-med-client/pom.xml index 372761ce..c586b662 100644 --- a/a1-med-client/pom.xml +++ b/a1-med-client/pom.xml @@ -31,7 +31,7 @@ limitations under the License. org.o-ran-sc.ric.a1med.client a1-med-client RIC A1 Mediator client - 0.3.0-SNAPSHOT + 0.4.0-SNAPSHOT UTF-8 UTF-8 @@ -101,7 +101,7 @@ limitations under the License. generate - ${project.basedir}/src/main/resources/a1_mediator_0.3.0.yaml + ${project.basedir}/src/main/resources/a1_mediator_0.4.0.yaml java ${client.base.package.name} ${client.base.package.name}.model diff --git a/a1-med-client/src/main/resources/a1_mediator_0.4.0.yaml b/a1-med-client/src/main/resources/a1_mediator_0.4.0.yaml new file mode 100644 index 00000000..7e12bc66 --- /dev/null +++ b/a1-med-client/src/main/resources/a1_mediator_0.4.0.yaml @@ -0,0 +1,102 @@ +# ========================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=================================== +openapi: 3.0.0 +info: + version: 0.4.0 + title: RIC A1 +paths: + '/ric/policies/{policyname}': + parameters: + - name: policyname + in: path + description: the name of the policy to retrieve or replace + required: true + schema: + type: string + put: + description: > + Replace the current operation of policyname with the new parameters (replaces the current policy with the new one specified here). + + + Until there are standard policy definitions that are defined OUTSIDE of the scope of xapps, this API will be *very underspecified*. + This is a known gap, do not despair. + The PUT body is specified, *currently* in the xapp manifest that implements this policy; the caller should refer to the message_receives_payload_schema field to make this request. + The return content is also specified as above (in the xapp manifest) in the message_sends_payload_schema field. + + + Eventually, we need concrete policy defintions that are decoupled from xapp, and then this API description will become more fully specified. + tags: + - A1 Mediator + operationId: a1.controller.put_handler + requestBody: + content: + application/json: + schema: + type: object + + + responses: + '200': + description: > + The downstream component responsible for implementing this policy replied with a good response. Check the manifest for response details. + '400': + description: > + Bad PUT body for this policyname + '404': + description: > + there is no policy with this name + '502': + description: > + The xapp that implements this policy replied, but the reply was a "failure", OR there was no status indicating success or failure. + This returns an object containing the reason, and the return payload. + content: + application/json: + schema: + type: object + properties: + reason: + type: string + enum: [ + "NO STATUS", + "BAD STATUS", + "NOT JSON" + ] + return_payload: + type: object + + '504': + description: > + the downstream component responsible for handling this policy did not respond (in time) + + get: + description: Get the current state/value of policyname + tags: + - A1 Mediator + operationId: a1.controller.get_handler + responses: + '200': + description: > + policy state successfully retrieved. + TODO, what describes the format returned here? + content: + application/json: + schema: + type: object + '404': + description: there is no policy with this name + diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 7507f617..a56d8165 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -22,6 +22,7 @@ RIC Dashboard Release Notes Version 1.0.2, 9 May 2019 ------------------------- +* Update A1 mediator client to version 0.4.0 * Add E2 response message with timestamp and status code * Fetch xAPP instance status information from xAPP Manager and display in dashboard diff --git a/webapp-backend/pom.xml b/webapp-backend/pom.xml index 5eecd334..426e7ce4 100644 --- a/webapp-backend/pom.xml +++ b/webapp-backend/pom.xml @@ -37,7 +37,7 @@ limitations under the License. org.o-ran-sc.ric.a1med.client a1-med-client - 0.3.0-SNAPSHOT + 0.4.0-SNAPSHOT org.o-ran-sc.ric.anrxapp.client -- 2.16.6