X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=a1%2Fopenapi.yaml;h=a49cf799b2eeab8aef33b8b7df9d433b13466ecc;hb=refs%2Fchanges%2F81%2F781%2F3;hp=1d121d1e33bf5893be2bf12385c55a9cd83a6e40;hpb=cc2250acf384412fdd606e83f93f9802b1397dbe;p=ric-plt%2Fa1.git diff --git a/a1/openapi.yaml b/a1/openapi.yaml index 1d121d1..a49cf79 100644 --- a/a1/openapi.yaml +++ b/a1/openapi.yaml @@ -16,10 +16,22 @@ # ================================================================================== 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 @@ -31,13 +43,11 @@ paths: 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 @@ -88,6 +98,21 @@ 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. + content: + application/json: + schema: + type: object + '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) + +