X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=api%2Fswagger.yaml;h=0c5daee4d317b75ab0caff0cc40ca97961ae7e8d;hb=refs%2Fchanges%2F76%2F11876%2F1;hp=b7ca5265a3332e3fb54ac6db2fc3fee7074f7244;hpb=b7a743adb64d9a737e505d54fbdbe46777551d06;p=ric-plt%2Fa1.git diff --git a/api/swagger.yaml b/api/swagger.yaml index b7ca526..0c5daee 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -3,7 +3,7 @@ info: version: 2.1.0 title: RIC A1 paths: - /a1-p/healthcheck: + /A1-P/v2/healthcheck: get: description: | Perform a healthcheck on a1 @@ -16,7 +16,7 @@ paths: A1 is healthy. Anything other than a 200 should be considered a1 as failing parameters: [] - /a1-p/policytypes: + /A1-P/v2/policytypes: get: description: Get a list of all registered policy type ids tags: @@ -40,7 +40,7 @@ paths: parameters: [] produces: - application/json - '/a1-p/policytypes/{policy_type_id}': + '/A1-P/v2/policytypes/{policy_type_id}': parameters: - name: policy_type_id in: path @@ -118,7 +118,7 @@ paths: $ref: '#/definitions/policy_type_schema' consumes: - application/json - '/a1-p/policytypes/{policy_type_id}/policies': + '/A1-P/v2/policytypes/{policy_type_id}/policies': parameters: - name: policy_type_id in: path @@ -152,7 +152,7 @@ paths: parameters: [] produces: - application/json - '/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}': + '/A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}': parameters: - name: policy_type_id in: path @@ -170,6 +170,11 @@ paths: description: > represents a policy instance identifier. UUIDs are advisable but can be any string + - name: notificationDestination + in: query + type: string + description: > + URL send by non-RT RIC. This where non-RT RIC expects status updates on the policy creation get: description: | Retrieve the policy instance @@ -245,7 +250,7 @@ paths: the policy type consumes: - application/json - '/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}/status': + '/A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}/status': parameters: - name: policy_type_id in: path @@ -281,16 +286,17 @@ paths: schema: type: object properties: - instance_status: + enforceStatus: type: string enum: - - IN EFFECT - - NOT IN EFFECT - has_been_deleted: - type: boolean - created_at: + - ENFORCED + - NOT_ENFORCED + enforceReason: type: string - format: date-time + enum: + - SCOPE_NOT_APPLICABLE + - STATEMENT_NOT_APPLICABLE + - OTHER_REASON '404': description: > there is no policy instance with this policy_instance_id or there is