"version": "2.1.0"
},
"paths": {
- "/a1-p/healthcheck": {
+ "/A1-P/v2/healthcheck": {
"get": {
"description": "Perform a healthcheck on a1\n",
"tags": [
}
}
},
- "/a1-p/policytypes": {
+ "/A1-P/v2/policytypes": {
"get": {
"description": "Get a list of all registered policy type ids",
"produces": [
}
}
},
- "/a1-p/policytypes/{policy_type_id}": {
+ "/A1-P/v2/policytypes/{policy_type_id}": {
"get": {
"description": "Get this policy type\n",
"produces": [
}
]
},
- "/a1-p/policytypes/{policy_type_id}/policies": {
+ "/A1-P/v2/policytypes/{policy_type_id}/policies": {
"get": {
"description": "get a list of all policy instance ids for this policy type id",
"produces": [
}
]
},
- "/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}": {
+ "/A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}": {
"get": {
"description": "Retrieve the policy instance\n",
"produces": [
"name": "policy_instance_id",
"in": "path",
"required": true
+ },
+ {
+ "type": "string",
+ "description": "URL send by non-RT RIC. This where non-RT RIC expects status updates on the policy creation\n",
+ "name": "notificationDestination",
+ "in": "query"
}
]
},
- "/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}/status": {
+ "/A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}/status": {
"get": {
"description": "Retrieve the policy instance status across all handlers of the policy If this endpoint returns successfully (200), it is either IN EFFECT or NOT IN EFFECT. IN EFFECT is returned if at least one policy handler in the RIC is implementing the policy NOT IN EFFECT is returned otherwise If a policy instance is successfully deleted, this endpoint will return a 404 (not a 200)\n",
"produces": [
"schema": {
"type": "object",
"properties": {
- "created_at": {
+ "enforceReason": {
"type": "string",
- "format": "date-time"
- },
- "has_been_deleted": {
- "type": "boolean"
+ "enum": [
+ "SCOPE_NOT_APPLICABLE",
+ "STATEMENT_NOT_APPLICABLE",
+ "OTHER_REASON"
+ ]
},
- "instance_status": {
+ "enforceStatus": {
"type": "string",
"enum": [
- "IN EFFECT",
- "NOT IN EFFECT"
+ "ENFORCED",
+ "NOT_ENFORCED"
]
}
}
"version": "2.1.0"
},
"paths": {
- "/a1-p/healthcheck": {
+ "/A1-P/v2/healthcheck": {
"get": {
"description": "Perform a healthcheck on a1\n",
"tags": [
}
}
},
- "/a1-p/policytypes": {
+ "/A1-P/v2/policytypes": {
"get": {
"description": "Get a list of all registered policy type ids",
"produces": [
}
}
},
- "/a1-p/policytypes/{policy_type_id}": {
+ "/A1-P/v2/policytypes/{policy_type_id}": {
"get": {
"description": "Get this policy type\n",
"produces": [
}
]
},
- "/a1-p/policytypes/{policy_type_id}/policies": {
+ "/A1-P/v2/policytypes/{policy_type_id}/policies": {
"get": {
"description": "get a list of all policy instance ids for this policy type id",
"produces": [
}
]
},
- "/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}": {
+ "/A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}": {
"get": {
"description": "Retrieve the policy instance\n",
"produces": [
"name": "policy_instance_id",
"in": "path",
"required": true
+ },
+ {
+ "type": "string",
+ "description": "URL send by non-RT RIC. This where non-RT RIC expects status updates on the policy creation\n",
+ "name": "notificationDestination",
+ "in": "query"
}
]
},
- "/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}/status": {
+ "/A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}/status": {
"get": {
"description": "Retrieve the policy instance status across all handlers of the policy If this endpoint returns successfully (200), it is either IN EFFECT or NOT IN EFFECT. IN EFFECT is returned if at least one policy handler in the RIC is implementing the policy NOT IN EFFECT is returned otherwise If a policy instance is successfully deleted, this endpoint will return a 404 (not a 200)\n",
"produces": [
"schema": {
"type": "object",
"properties": {
- "created_at": {
+ "enforceReason": {
"type": "string",
- "format": "date-time"
- },
- "has_been_deleted": {
- "type": "boolean"
+ "enum": [
+ "SCOPE_NOT_APPLICABLE",
+ "STATEMENT_NOT_APPLICABLE",
+ "OTHER_REASON"
+ ]
},
- "instance_status": {
+ "enforceStatus": {
"type": "string",
"enum": [
- "IN EFFECT",
- "NOT IN EFFECT"
+ "ENFORCED",
+ "NOT_ENFORCED"
]
}
}