X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=77bbd0d896444397f0d69428c5b583e37c35221c;hb=8cffee5976e66653c08f55abfe59663ecfd44f66;hp=d2397ee71bb33d6e801430858e8d61b835e7ec9b;hpb=0a4c38bb5bfc553c6515a447bb70824988830f84;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index d2397ee7..77bbd0d8 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,36 +17,45 @@ 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 +============================ + +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 + +Enrichment Coordinator Service +============================== -The Non-RT RIC consists of two parts, described in the sections below: - * The Policy Agent - * The SDNC A1 Controller +See `ECS API <./ecs-api.html>`_ for how to use the API. +.. csv-table:: + :header: "API name", "|swagger-icon|", "|yaml-icon|" + :widths: 10,5,5 -Policy Agent -============ + "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`" -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 :ref:`policy-agent-api` for how to use the API. +Service Catalogue +================= -See the README.md file in the nonrtric/policy-agent repo for info about how to use it. +The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover. -API Functions -------------- -See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml +See `SC API <./rac-api.html>`_ for how to use the API. -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 the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. + "SC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`" Complementary tools ===================