X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fpolicy-agent-api.rst;fp=docs%2Fpolicy-agent-api.rst;h=8a46fc711f07ec5d1027d0bd8e24060b0470b732;hb=f85d5640c9e3ebec82f6de62d0f1c9d70efe8945;hp=e3354e4563f2e2faf6c6d9f67b6892b0d1847b2a;hpb=d3920fdf9938291fcd01388deea763d097b0d6c8;p=nonrtric.git diff --git a/docs/policy-agent-api.rst b/docs/policy-agent-api.rst index e3354e45..8a46fc71 100644 --- a/docs/policy-agent-api.rst +++ b/docs/policy-agent-api.rst @@ -634,12 +634,12 @@ GET Returns a policy configuration. **URL path:** - /policy?instance= + /policy?id= **Parameters:** - instance: (*Required*) - The ID/name of the policy instance. + id: (*Required*) + The ID of the policy instance. **Responses:** @@ -647,7 +647,7 @@ GET JSON object containing policy information. :: { - "id": "string", (ID/name of policy) + "id": "string", (ID of policy) "json": "object", (JSON with policy data speified by the type) "ownerServiceName": "string", (Name of the service that created the policy) "ric": "string", (Name of the Near |nbh| RT |nbsp| RIC where the policy resides) @@ -662,7 +662,7 @@ GET Call: :: - curl -X GET "http://localhost:8081/policy?instance=Policy 1" + curl -X GET "http://localhost:8081/policy?id=Policy 1" Result: 200: :: @@ -696,7 +696,7 @@ GET Call: :: - curl -X GET "http://localhost:8081/policy?instance=nonexistent" + curl -X GET "http://localhost:8081/policy?id=nonexistent" Result: 404: :: @@ -710,12 +710,12 @@ PUT "*Keep Alive Interval*" registered. **URL path:** - /policy?instance=&ric=&service=&type= + /policy?id=&ric=&service=&type= **Parameters:** - instance: (*Required*) - The ID/name of the policy instance. + id: (*Required*) + The ID of the policy instance. ric: (*Required*) The name of the Near |nbh| RT |nbsp| RIC where the policy will be created. @@ -747,7 +747,7 @@ PUT Call: :: - curl -X PUT "http://localhost:8081/policy?instance=Policy%201&ric=ric1&service=Service%201&type=STD_PolicyModelUnconstrained_0.2.0" + curl -X PUT "http://localhost:8081/policy?id=Policy%201&ric=ric1&service=Service%201&type=STD_PolicyModelUnconstrained_0.2.0" -H "Content-Type: application/json" -d "{ \"scope\": { @@ -779,12 +779,12 @@ DELETE "*Keep Alive Interval*" registered. **URL path:** - /policy?instance= + /policy?id= **Parameters:** - instance: (*Required*) - The ID/name of the policy instance. + id: (*Required*) + The ID of the policy instance. **Responses:** @@ -798,7 +798,7 @@ DELETE Call: :: - curl -X DELETE "http://localhost:8081/policy?instance=Policy 1" + curl -X DELETE "http://localhost:8081/policy?id=Policy 1" Result: 204 @@ -866,12 +866,12 @@ GET Returns the status of a policy. **URL path:** - /policy_status?instance= + /policy_status?id= **Parameters:** - instance: (*Required*) - The ID/name of the policy. + id: (*Required*) + The ID of the policy. **Responses:**