Add curl examples to gateway API doc 81/6181/3
authorelinuxhenrik <henrik.b.andersson@est.tech>
Tue, 1 Jun 2021 10:56:09 +0000 (12:56 +0200)
committerelinuxhenrik <henrik.b.andersson@est.tech>
Tue, 1 Jun 2021 11:43:37 +0000 (13:43 +0200)
Isue-ID: NONRTRIC-531
Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
Change-Id: Ied06ae60b74cc199958d95ee7ea245423ddaabba

docs/api-docs.rst
docs/developer-guide.rst

index a3b447b..85adbed 100644 (file)
@@ -37,4 +37,11 @@ Look under the "PORTS" column to see the port used by the Gateway.
 
 The Gateway supports calls to the A1 Policy Management Service and A1 Enrichment Information Coordinator.
 See `A1 Policy Management Service API <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/api-docs.html#a1-policy-management-service>`__
-and `A1 Enrichment Information Coordinator API <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/api-docs.html#enrichment-coordinator-service>`__.
\ No newline at end of file
+and `A1 Enrichment Information Coordinator API <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/api-docs.html#enrichment-coordinator-service>`__.
+
+Some examples on how to call the gateway with CURL:
+
+ .. code-block:: bash
+
+   curl localhost:9090/a1-policy/v2/policy-instances
+   curl localhost:9090/data-producer/v1/info-types
index ca42ed3..eb4d6b7 100644 (file)
@@ -18,7 +18,8 @@ See the README.md file in the nonrtric-controlpanel repo for information about h
 Start the Control Panel for development
 ---------------------------------------
 
-To run the Control Panel locally for development , follow the steps below.
+To run the Control Panel locally for development, follow the steps below.
+
 
 First, fetch the latest code from `gerrit <https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel>`_ and
 go in to the frontend folder in the repo: