X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=660344f13be0d95aed190e197226300297e70e6a;hb=0268b146cb35f0b5cdc4f8deb2668055bc4ce940;hp=94169403f8bf56fa0af3cf669dc8b27bcec4f031;hpb=13c62d122c38b98cbdc76a4a775c6f6187e40e39;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index 94169403..660344f1 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -4,80 +4,83 @@ .. _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 +* The Non-RT-RIC App Catalogue +* 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/onap/oran/docs/offeredapis/swagger/pms-api.yaml - -SDNC A1 Controller -================== - -An ONAP SDNC Controller for the A1 interface. +.. csv-table:: + :header: "API name", "|swagger-icon|", "|yaml-icon|" + :widths: 10,5,5 -See :ref:`sdnc-a1-controller-api` for how to use the API. + "A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`" -See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. +Non-RT-RIC App Catalogue (Initial) +================================== -rAPP Catalogue -============== +The Service Catalogue provides a way for services to register themselves for other services to discover. -The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover. +See `Service Catalogue API <./rac-api.html>`_ for full details of the API. -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 +The API is also described in Swagger-JSON and YAML: .. 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>`" + "Service Catalogue API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`" + +K8S Helm Chart LCM Manager (Initial) +==================================== -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. +See Also: Non-RT RIC Control Panel +================================== 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 `. + +Documentation for the Control Panel can be found here: `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: :: +See Also: A1 / Near-RT RIC simulator +==================================== + +The Near-RT RIC simulator simulates an A1 protocol termination endpoint. + +Documentation for the simulator can be found here: `A1 Interface Simulator `_. + +It can be downloaded from here: :: git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"