85adbedd4abf0da2ad377197c984376c48030c08
[portal/nonrtric-controlpanel.git] / docs / api-docs.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2021 Nordix
4
5 .. _api_docs:
6
7 ========
8 API-Docs
9 ========
10
11 This document describes the API to access the Non-RT RIC Gateway.
12
13 The Gateway acts as a mediator for services provided by the Non-RT RIC project. This means that users only need to
14 know about one address to access the content of the Non-RT Ric.
15
16 The default value for the Gateway port is 9090. There are different ways to find out which port that is actually used.
17
18 If Kubernetes is used, run the following command:
19
20  .. code-block:: bash
21
22     kubectl get svc -n nonrtric | grep gateway
23
24 With the name from the "NAME" column, run the following command:
25
26  .. code-block:: bash
27
28     kubectl describe svc -n nonrtric [name]
29
30 If Docker is used, run the following command:
31
32  .. code-block:: bash
33
34     docker ps | grep gateway
35
36 Look under the "PORTS" column to see the port used by the Gateway.
37
38 The Gateway supports calls to the A1 Policy Management Service and A1 Enrichment Information Coordinator.
39 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>`__
40 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>`__.
41
42 Some examples on how to call the gateway with CURL:
43
44  .. code-block:: bash
45
46    curl localhost:9090/a1-policy/v2/policy-instances
47    curl localhost:9090/data-producer/v1/info-types