X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=a1%2Fopenapi.yaml;h=f35a742c89a3c642f21d238e9b467f815691e914;hb=refs%2Fchanges%2F07%2F1907%2F13;hp=fed4b77546264cc8a390504dae725ca15060d81a;hpb=bfa46147cce23a46a49fb53dfae8a790b0fe34e4;p=ric-plt%2Fa1.git diff --git a/a1/openapi.yaml b/a1/openapi.yaml index fed4b77..f35a742 100644 --- a/a1/openapi.yaml +++ b/a1/openapi.yaml @@ -16,7 +16,7 @@ # ================================================================================== openapi: 3.0.0 info: - version: 1.0.0 + version: 2.0.0 title: RIC A1 paths: '/a1-p/healthcheck': @@ -273,12 +273,21 @@ paths: description: > successfully retrieved the status content: - text/plain: + application/json: schema: - type: string - enum: - - IN EFFECT - - NOT IN EFFECT + type: object + properties: + instance_status: + type: string + enum: + - IN EFFECT + - NOT IN EFFECT + has_been_deleted: + type: boolean + created_at: + type: string + format: date-time + '404': description: > there is no policy instance with this policy_instance_id or there is no policy type with this policy_type_id @@ -312,76 +321,11 @@ components: description: > represents a policy type identifier. Currently this is restricted to an integer range. type: integer - minimum: 20000 - maximum: 21023 + minimum: 1 + maximum: 2147483647 policy_instance_id: description: > represents a policy instance identifier. UUIDs are advisable but can be any string type: string example: "3d2157af-6a8f-4a7c-810f-38c2f824bf12" - - downstream_message_schema: - type: object - required: - - operation - - policy_type_id - - policy_instance_id - - payload - additionalProperties: false - properties: - operation: - description: the operation being performed - type: string - enum: - - CREATE - - DELETE - - UPDATE - - READ - policy_type_id: - "$ref": "#/components/schemas/policy_type_id" - policy_instance_id: - "$ref": "#/components/schemas/policy_instance_id" - payload: - description: payload for this operation - type: object - example: - operation: CREATE - policy_type_id: 12345678 - policy_instance_id: 3d2157af-6a8f-4a7c-810f-38c2f824bf12 - payload: - enforce: true - window_length: 10 - blocking_rate: 20 - trigger_threshold: 10 - - downstream_notification_schema: - type: object - required: - - policy_type_id - - policy_instance_id - - handler_id - - status - additionalProperties: false - properties: - policy_type_id: - "$ref": "#/components/schemas/policy_type_id" - policy_instance_id: - "$ref": "#/components/schemas/policy_instance_id" - handler_id: - description: > - id of the policy handler - type: string - status: - description: > - the status of this policy instance in this handler - type: string - enum: - - OK - - ERROR - - DELETED - example: - policy_type_id: 12345678 - policy_instance_id: 3d2157af-6a8f-4a7c-810f-38c2f824bf12 - handler_id: 1234-5678 - status: OK