X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fuser-guide-api.rst;h=5136d06e3f7edd09b9996c65651df81b25f76f2c;hb=refs%2Fchanges%2F81%2F3881%2F5;hp=2dcd31e6dbb16b5f1fd22ecf8e805d7c607009a1;hpb=39c9ab62125be03194b4c433b4f9fa4617d0a65d;p=ric-plt%2Fa1.git diff --git a/docs/user-guide-api.rst b/docs/user-guide-api.rst index 2dcd31e..5136d06 100644 --- a/docs/user-guide-api.rst +++ b/docs/user-guide-api.rst @@ -4,6 +4,10 @@ User Guide and APIs =================== +.. contents:: + :depth: 3 + :local: + This document explains how to communicate with the A1 Mediator. Information for maintainers of this platform component is in the Developer Guide. @@ -33,6 +37,12 @@ a single integer value: } +For example, if you put the JSON above into a file called "create.json" you can use +the curl command-line tool to send the request:: + + curl -X PUT --header "Content-Type: application/json" --data-raw @create.json http://localhost/a1-p/policytypes/20008 + + Send the following JSON to create an instance of policy type 20008: .. code-block:: yaml @@ -42,6 +52,11 @@ Send the following JSON to create an instance of policy type 20008: } +For example, you can use the curl command-line tool to send this request:: + + curl -X PUT --header "Content-Type: application/json" --data '{"threshold" : 5}' http://localhost/a1-p/policytypes/20008/policies/tsapolicy145 + + Integrating Xapps with A1 -------------------------