X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=a1%2Fopenapi.yaml;h=66094ef844649c000f38499aa511ce8bc6160cd0;hb=d5024709403d3ae909b91af8cd04c9caef1e49c6;hp=aa02cc698e3ffcb5055197d56827a213b58e7765;hpb=5ad8f03e1fc7683bb59da31f59edc2f6c0b2372b;p=ric-plt%2Fa1.git diff --git a/a1/openapi.yaml b/a1/openapi.yaml index aa02cc6..66094ef 100644 --- a/a1/openapi.yaml +++ b/a1/openapi.yaml @@ -1,9 +1,37 @@ +# ================================================================================== +# Copyright (c) 2019 Nokia +# Copyright (c) 2018-2019 AT&T Intellectual Property. +# +# 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: - version: 0.8.0 + version: 0.10.3 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 @@ -72,6 +100,17 @@ paths: - A1 Mediator operationId: a1.controller.get_handler responses: - '501': + '200': description: > - "future GET support has been pondered, but this is not currently implemented"U + 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 + '504': + description: > + the downstream component responsible for handling this policy did not respond (in time) + +