X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Fapi-docs.rst;h=27cd338eb5a506643044dc60c4307ea86878bd35;hb=248487e4d6f6417da3d0f6784e20e81bcb4330d7;hp=9b0608a6c959b42ebd9d66ea1e5b95676f8567b3;hpb=0b0cb1fdcf166e438c6932f1eb0f29dafafbe635;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index 9b0608a6..27cd338e 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,83 +1,69 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2020 Nordix +.. Copyright (C) 2021 Nordix .. _api_docs: +.. |swagger-icon| image:: ./images/swagger.png + :width: 40px + +.. |yaml-icon| image:: ./images/yaml_logo.png + :width: 40px + ======== API-Docs ======== -This is the API-docs of Non-RT RIC. +Here we describe the APIs to access the Non-RT RIC functions. -.. contents:: - :depth: 3 - :local: +The core Non-RT RIC consists of several parts, with available APIs 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 +* The A1 Policy Management Service +* The Information Coordinator Service +* K8S Helm Chart LCM Manager (Initial) **** +A1 Policy Management Service +============================ -Policy Agent -============ +For information about the A1 Policy Management Service that is implemented in ONAP, see `ONAP docs `_ and `wiki `_. -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. +Information Coordinator Service +=============================== -See :ref:`policy-agent-api` for how to use the API. +See `A1 Information Information Coordination Service API <./ics-api.html>`_ for full details of the API. -See the README.md file in the nonrtric/policy-agent repo for info about how to use it. +The API is also described in Swagger-JSON and YAML: -API Functions -------------- -See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml - -SDNC A1 Controller -================== - -An ONAP SDNC Controller for the A1 interface. - -See :ref:`sdnc-a1-controller-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/sdnc-a1-controller repo for info about how to use it. + "A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`" -rAPP Catalogue -============== +K8S Helm Chart LCM Manager (Initial) +==================================== -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. +See Also: Non-RT RIC Control Panel +================================== -.. |swagger-icon| image:: ./images/swagger.png - :width: 40px +The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC. -.. |yaml-icon| image:: ./images/yaml_logo.png - :width: 40px +Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel `_. +It can be downloaded from here: :: -.. csv-table:: - :header: "API name", "|swagger-icon|", "|yaml-icon|" - :widths: 10,5, 5 + git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel". - "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`" +See Also: A1 / Near-RT RIC simulator +==================================== -Complementary tools -=================== +The Near-RT RIC simulator simulates an A1 protocol termination endpoint. -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. +Documentation for the simulator can be found here: `A1 Interface 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 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: :: - git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"