X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=a1%2Fopenapi.yaml;fp=a1%2Fopenapi.yaml;h=81e88d15456df4a51db81420065c358222a21027;hb=fdf050451414e1a816e343bcd56f33186a742e49;hp=1d121d1e33bf5893be2bf12385c55a9cd83a6e40;hpb=24514469850dc9a543869f132385633039c5f5a6;p=ric-plt%2Fa1.git diff --git a/a1/openapi.yaml b/a1/openapi.yaml index 1d121d1..81e88d1 100644 --- a/a1/openapi.yaml +++ b/a1/openapi.yaml @@ -16,9 +16,21 @@ # ================================================================================== openapi: 3.0.0 info: - version: 0.8.0 + version: 0.9.0 title: RIC A1 paths: + '/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 + '/ric/policies/{policyname}': parameters: - name: policyname @@ -88,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) + +