X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=ef234a5661f603c785a6530598865c737fea4b4c;hb=01ea4be5a7b6db523676a766fc4eef72385cb01a;hp=77bbd0d896444397f0d69428c5b583e37c35221c;hpb=e2a44d9cc44c143d4df4102aa03b251aa9604d63;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index 77bbd0d8..ef234a56 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -15,61 +15,72 @@ API-Docs ======== -This is the API-docs of Non-RT RIC. +Here we describe the APIs to access the Non-RT RIC functions. -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 +The core Non-RT RIC consists of several parts, with available APIs described in the sections below: +* The A1 Policy Management Service +* The Enrichment Coordinator Service +* The Non-RT-RIC App Catalogue +* K8S Helm Chart LCM Manager (Initial) **** A1 Policy Management Service ============================ -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 +For information about the A1 Policy Management Service that is implemented in ONAP, see `ONAP docs `_ and `wiki `_. Enrichment Coordinator Service ============================== -See `ECS API <./ecs-api.html>`_ for how to use the API. +See `A1 Enrichment Information Coordination Service API <./ecs-api.html>`_ for full details of the API. + +The API is also described in Swagger-JSON and YAML: .. csv-table:: :header: "API name", "|swagger-icon|", "|yaml-icon|" :widths: 10,5,5 - "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`" + "A1 Enrichment Information Coordination Service API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`" +Non-RT-RIC App Catalogue (Initial) +================================== -Service 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 `SC API <./rac-api.html>`_ for how to use the API. +The API is also described in Swagger-JSON and YAML: .. csv-table:: :header: "API name", "|swagger-icon|", "|yaml-icon|" :widths: 10,5, 5 - "SC 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"