Updating the documentation for the change in url 76/11876/1
authornaman.gupta <naman.gupta@samsung.com>
Tue, 10 Oct 2023 13:27:47 +0000 (18:57 +0530)
committernaman.gupta <naman.gupta@samsung.com>
Tue, 10 Oct 2023 13:37:18 +0000 (19:07 +0530)
Updating the documentation for the change in url to align with the latest specification.

Change-Id: I6812535c3556083ce8b44ad2fb03dc857eb3f6a7
Signed-off-by: naman.gupta <naman.gupta@samsung.com>
docs/developer-guide.rst
docs/installation-guide.rst
docs/release-notes.rst
docs/user-guide-api.rst

index f2db426..e2e258b 100644 (file)
@@ -28,7 +28,7 @@ repository and exposing the server's HTTP port on the Docker host::
 
 Then test the server with an invocation such as this::
 
-    curl localhost:10000/a1-p/healthcheck
+    curl localhost:10000/A1-P/v2/healthcheck
 
 
 Integration testing
index 9a19179..c6d1752 100644 (file)
@@ -52,4 +52,4 @@ Storage Data Layer (SDL) service is not available or has not been mocked as show
 
 ::
 
-    curl docker-host-name-or-ip:10000/a1-p/healthcheck
+    curl docker-host-name-or-ip:10000/A1-P/v2/healthcheck
index af50338..092b99e 100644 (file)
@@ -294,7 +294,7 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
 
 ::
 
-   * Rename all /ric/ URLs to be consistent with requirements of /a1-p/
+   * Rename all /ric/ URLs to be consistent with requirements of /A1-P/v2/
 
 
 [0.9.0] - 7/22/2019
index 743f898..bd7e1be 100644 (file)
@@ -42,7 +42,7 @@ the curl command-line tool to send the request::
 
 .. code::
     
-    $ curl -X PUT --header "Content-Type: application/json" --data-raw @create.json "http://localhost/a1-p/policytypes/20008"
+    $ curl -X PUT --header "Content-Type: application/json" --data-raw @create.json "http://localhost/A1-P/v2/policytypes/20008"
 
 
 Send the following JSON to create an instance of policy type 20008:
@@ -58,7 +58,7 @@ For example, you can use the curl command-line tool to send this request::
 
 .. code::
 
-    $ curl -X PUT --header "Content-Type: application/json" --data '{"threshold" : 5}' "http://localhost/a1-p/policytypes/20008/policies/tsapolicy145"
+    $ curl -X PUT --header "Content-Type: application/json" --data '{"threshold" : 5}' "http://localhost/A1-P/v2/policytypes/20008/policies/tsapolicy145"
 
 
 Integrating Xapps with A1
@@ -102,7 +102,7 @@ Following are the api and the response::
 
 .. code::
 
-    $ curl -v -X GET "http://localhost/a1-p/healthcheck"
+    $ curl -v -X GET "http://localhost/A1-P/v2/healthcheck"
 
 .. code-block:: yaml  
 
@@ -112,7 +112,7 @@ Following are the api and the response::
 
 .. code::
 
-    $ curl -X GET "http://localhost/a1-p/policytypes/"
+    $ curl -X GET "http://localhost/A1-P/v2/policytypes/"
 
 .. code-block:: yaml
 
@@ -123,7 +123,7 @@ Following are the api and the response::
 
 .. code::
 
-    $ curl -s -X GET "http://localhost/a1-p/policytypes/20001" | jq .
+    $ curl -s -X GET "http://localhost/A1-P/v2/policytypes/20001" | jq .
 
 .. code-block:: yaml
 
@@ -163,7 +163,7 @@ Following are the api and the response::
 
 .. code::
 
-    $ curl -s -X GET "http://localhost/a1-p/policytypes/20001/policies/" | jq .
+    $ curl -s -X GET "http://localhost/A1-P/v2/policytypes/20001/policies/" | jq .
 
 .. code-block:: yaml
   
@@ -176,7 +176,7 @@ Following are the api and the response::
 
 .. code::
 
-    $ curl -s -X GET "http://localhost/a1-p/policytypes/20001/policies/1234" | jq .
+    $ curl -s -X GET "http://localhost/A1-P/v2/policytypes/20001/policies/1234" | jq .
 
 .. code-block:: yaml
 
@@ -191,7 +191,7 @@ Following are the api and the response::
 
 .. code::
 
-    $ curl -X PUT "http://localhost/a1-p/policytypes/21003/" -H "Content-Type: application/json" -d @policy_schema_ratecontrol.json
+    $ curl -X PUT "http://localhost/A1-P/v2/policytypes/21003/" -H "Content-Type: application/json" -d @policy_schema_ratecontrol.json
 
 
     $ cat policy_schema_ratecontrol.json
@@ -321,7 +321,7 @@ Following are the api and the response::
 
 .. code::
 
-    $ curl -X PUT "http://localhost/a1-p/policytypes/21003/policies/1234" -H "Content-Type: application/json" -d @policy_instance_ratecontrol.json
+    $ curl -X PUT "http://localhost/A1-P/v2/policytypes/21003/policies/1234" -H "Content-Type: application/json" -d @policy_instance_ratecontrol.json
     
     $ cat policy_instance_ratecontrol.json
 
@@ -340,7 +340,7 @@ Following are the api and the response::
     
 .. code::
 
-    $ curl -s -X GET "http://localhost/a1-p/policytypes/21004/policies/1235/status" | jq .
+    $ curl -s -X GET "http://localhost/A1-P/v2/policytypes/21004/policies/1235/status" | jq .
 
 .. code-block:: yaml
   
@@ -354,13 +354,13 @@ Following are the api and the response::
     
 .. code::
 
-    $ curl -s -X DELETE "http://localhost/a1-p/policytypes/21004/"
+    $ curl -s -X DELETE "http://localhost/A1-P/v2/policytypes/21004/"
 
 #. Delete policy instance
     
 .. code::
 
-    $ curl -s -X DELETE "http://localhost/a1-p/policytypes/21004/policies/1234/"
+    $ curl -s -X DELETE "http://localhost/A1-P/v2/policytypes/21004/policies/1234/"
 
 #. A1-EI data delivery for a job id: