X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=9b0608a6c959b42ebd9d66ea1e5b95676f8567b3;hb=5ada515a9b796bdcb0a78c7fd4eb3512bd21c031;hp=a4cdf08a5bc9d9f68dd140b5bf31c05da734f092;hpb=0316038265be758ae8b1bce006b5fd017185c55d;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index a4cdf08a..9b0608a6 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,5 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2020 Nordix + +.. _api_docs: ======== @@ -12,9 +15,10 @@ This is the API-docs of Non-RT RIC. :depth: 3 :local: -The Non-RT RIC consists of two parts, described in the sections below: +The Non-RT RIC consists of three parts, described in the sections below: * The Policy Agent * The SDNC A1 Controller + * The rAPP Catalogue Policy Agent @@ -37,14 +41,43 @@ SDNC A1 Controller An ONAP SDNC Controller for the A1 interface. +See :ref:`sdnc-a1-controller-api` for how to use the API. + See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. +rAPP Catalogue +============== + +The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover. + +See `RAC API <./rac-api.html>`_ for how to use the API. + +.. |swagger-icon| image:: ./images/swagger.png + :width: 40px + +.. |yaml-icon| image:: ./images/yaml_logo.png + :width: 40px + + +.. csv-table:: + :header: "API name", "|swagger-icon|", "|yaml-icon|" + :widths: 10,5, 5 + + "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`" + Complementary tools =================== There are two additional tools that can be used together with the Non-RT RIC, namely the Control Panel and the Near-RT RIC simulator. The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC. -It can be downloaded using: git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel" +Documentation for the Control Panel can be found here: +:doc:`Non-RT RIC Control Panel `. +It can be downloaded from here: :: + + git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel". + +The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found +here: :doc:`A1 Interface Simulator `. It can be downloaded from here: :: -The Near-RT RIC simulator does what its name suggests, and can be downloaded here: git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface" + git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"