From 944400b092e0931f21ffa0079915fc2dcf80f3d0 Mon Sep 17 00:00:00 2001 From: elinuxhenrik Date: Tue, 1 Jun 2021 12:56:09 +0200 Subject: [PATCH] Add curl examples to gateway API doc Isue-ID: NONRTRIC-531 Signed-off-by: elinuxhenrik Change-Id: Ied06ae60b74cc199958d95ee7ea245423ddaabba --- docs/api-docs.rst | 9 ++++++++- docs/developer-guide.rst | 3 ++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/api-docs.rst b/docs/api-docs.rst index a3b447b..85adbed 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -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 `__ -and `A1 Enrichment Information Coordinator API `__. \ No newline at end of file +and `A1 Enrichment Information Coordinator API `__. + +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 diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index ca42ed3..eb4d6b7 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -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 `_ and go in to the frontend folder in the repo: -- 2.16.6