From a38e36caa736b48ca6aefafc3f03eeb966f6efb5 Mon Sep 17 00:00:00 2001 From: "Lott, Christopher (cl778h)" Date: Wed, 31 Jul 2019 11:56:10 -0400 Subject: [PATCH] Update A1 mediator API to version 0.10.0 Change-Id: If9c4bbc932653397f225e55d6f7ec65f16f16e62 Signed-off-by: Lott, Christopher (cl778h) --- a1-med-client/pom.xml | 4 +- ...mediator_0.4.0.yaml => a1_mediator_0.10.0.yaml} | 62 ++++++++++------ .../src/main/resources/a1_mediator_0.3.0.yaml | 85 ---------------------- docs/release-notes.rst | 3 +- webapp-backend/pom.xml | 2 +- 5 files changed, 43 insertions(+), 113 deletions(-) rename a1-med-client/src/main/resources/{a1_mediator_0.4.0.yaml => a1_mediator_0.10.0.yaml} (61%) delete mode 100644 a1-med-client/src/main/resources/a1_mediator_0.3.0.yaml diff --git a/a1-med-client/pom.xml b/a1-med-client/pom.xml index f403e5c9..dd4a9e30 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.plt.a1med.client a1-med-client RIC A1 Mediator client - 0.4.0-SNAPSHOT + 0.10.0-SNAPSHOT UTF-8 UTF-8 @@ -102,7 +102,7 @@ limitations under the License. generate - ${project.basedir}/src/main/resources/a1_mediator_0.4.0.yaml + ${project.basedir}/src/main/resources/a1_mediator_0.10.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.10.0.yaml similarity index 61% rename from a1-med-client/src/main/resources/a1_mediator_0.4.0.yaml rename to a1-med-client/src/main/resources/a1_mediator_0.10.0.yaml index 7e12bc66..e2d17ccb 100644 --- a/a1-med-client/src/main/resources/a1_mediator_0.4.0.yaml +++ b/a1-med-client/src/main/resources/a1_mediator_0.10.0.yaml @@ -1,26 +1,37 @@ -# ========================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 +# ================================================================================== +# Copyright (c) 2019 Nokia +# Copyright (c) 2018-2019 AT&T Intellectual Property. # -# http://www.apache.org/licenses/LICENSE-2.0 +# 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 # -# 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=================================== +# 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: - version: 0.4.0 + version: 0.10.0 title: RIC A1 paths: - '/ric/policies/{policyname}': + '/a1-p/healthcheck': + get: + description: > + perform a healthcheck on a1 + tags: + - A1 Mediator + operationId: a1.controller.healthcheck_handler + responses: + 200: + description: > + a1 is healthy. Anything other than a 200 should be considered a1 as failing + + '/a1-p/policies/{policyname}': parameters: - name: policyname in: path @@ -91,12 +102,15 @@ paths: responses: '200': description: > - policy state successfully retrieved. - TODO, what describes the format returned here? - content: - application/json: - schema: - type: object + The downstream component responsible for implementing this policy replied with a good response. Check the manifest for response details. + '400': + description: > + The downstream component for implementing this policy does not support policy fetching. '404': - description: there is no policy with this name + description: > + there is no policy with this name + '504': + description: > + the downstream component responsible for handling this policy did not respond (in time) + diff --git a/a1-med-client/src/main/resources/a1_mediator_0.3.0.yaml b/a1-med-client/src/main/resources/a1_mediator_0.3.0.yaml deleted file mode 100644 index ce97a4bc..00000000 --- a/a1-med-client/src/main/resources/a1_mediator_0.3.0.yaml +++ /dev/null @@ -1,85 +0,0 @@ -# ========================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.3.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 (this 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 - '409': - description: > - The xapp that implements this policy replied, but the reply was a "failure". This should be interpreted that the policy was NOT updated successfully. - '503': - description: > - the downstream component responsible for handling this policy did not respond appropriately 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 10560391..598daf64 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -20,7 +20,7 @@ RIC Dashboard Release Notes =========================== -Version 1.2.0, 26 July 2019 +Version 1.2.0, 31 July 2019 --------------------------- * Split URL properties into prefix/suffix parts * Add jacoco plugin to back-end for code coverage @@ -30,6 +30,7 @@ Version 1.2.0, 26 July 2019 * Extend mock endpoints to simulate delay seen in tests * Move mock configuration classes into test area * Add EPSDK-FW user management and Portal security +* Update A1 mediator client to spec version 0.10.0 Version 1.0.5, 5 July 2019 -------------------------- diff --git a/webapp-backend/pom.xml b/webapp-backend/pom.xml index 40db7710..a7ee92ba 100644 --- a/webapp-backend/pom.xml +++ b/webapp-backend/pom.xml @@ -52,7 +52,7 @@ limitations under the License. org.o-ran-sc.ric.plt.a1med.client a1-med-client - 0.4.0-SNAPSHOT + 0.10.0-SNAPSHOT org.o-ran-sc.ric.plt.appmgr.client -- 2.16.6