X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=9e438f67dd0f7682c0850d48c50842fa179ea659;hb=8fd8e9fc86a24be49d61841e381423120a41296d;hp=8736a6368b13e2b877d660592f5d1027503e9703;hpb=434089cd08ab3b283eb6d2ee034d3d4af9cf570f;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index 8736a636..9e438f67 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,5 +1,14 @@ .. 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: + +.. |swagger-icon| image:: ./images/swagger.png + :width: 40px + +.. |yaml-icon| image:: ./images/yaml_logo.png + :width: 40px ======== @@ -8,43 +17,59 @@ API-Docs This is the API-docs of Non-RT RIC. -.. contents:: - :depth: 3 - :local: +The Non-RT RIC consists of three parts, described in the sections below: + * The A1 Policy Management Service + * The Enrichment Coordinator Service + * The rAPP Catalogue + + +A1 Policy Management Service +============================ -The Non-RT RIC consists of two parts, described in the sections below: - * The Policy Agent - * The SDNC A1 Controller +For information about the A1 Policy Management Service that is implemented in ONAP, see `readthedocs`_ and `wiki`_. +.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html +.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984 -Policy Agent -============ +Enrichment Coordinator Service +============================== -The Policy Agent provides common functionality useful for R-Apps, for instance: - * A repository of available Near-RT RICs, their policy types and policy instances. - * An A1 connection to the Near-RT RICs. +See `ECS API <./ecs-api.html>`_ for how to use the API. -See :ref:`policy-agent-api` for how to use the API. +.. csv-table:: + :header: "API name", "|swagger-icon|", "|yaml-icon|" + :widths: 10,5,5 -See the README.md file in the nonrtric/policy-agent repo for info about how to use it. + "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`" -API Functions -------------- -See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml -SDNC A1 Controller -================== +rAPP Catalogue +============== -An ONAP SDNC Controller for the A1 interface. +The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover. -See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. +See `RAC API <./rac-api.html>`_ for how to use the API. + + +.. 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. +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. +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 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" +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"