X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=db23bcaf7213d130a751a821d74e3bfdce7e9215;hb=b2ef1d832b94af02c7a3acefb4c8c5e4db03242b;hp=8ab5b452d7a4da2dc60e05553c8bcc79a93eaa62;hpb=ea715211fab899b1fbe71e981b313ef6de71fa5a;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index 8ab5b452..db23bcaf 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -4,81 +4,12 @@ .. _api_docs: -.. |swagger-icon| image:: ./images/swagger.png - :width: 40px - -.. |yaml-icon| image:: ./images/yaml_logo.png - :width: 40px - ======== API-Docs ======== -Here we describe the APIs to access the Non-RT RIC functions. - -The core Non-RT RIC consists of several parts, with available APIs described in the sections below: - -* The A1 Policy Management Service -* The Information Coordinator Service -* DMaaP Adaptor -* 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 `ONAP docs `_ and `wiki `_. - -Information Coordinator Service -=============================== - -See `A1 Information Information Coordination Service API <./ics-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 - - "A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`" - -DMaaP Adaptor -============= - -The DMaaP Adaptor provides support for push delivery of any data received from DMaap or Kafka. - -See `DMaaP Adaptor API <./dmaap-adaptor-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 - - "DMaaP Adaptor API", ":download:`link <../dmaap-adaptor-java/api/api.json>`", ":download:`link <../dmaap-adaptor-java/api/api.yaml>`" - -Non-RT-RIC App Catalogue (Initial) -================================== - -The 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. - -The API is also described in Swagger-JSON and YAML: - - -.. csv-table:: - :header: "API name", "|swagger-icon|", "|yaml-icon|" - :widths: 10,5, 5 - - "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) -==================================== - -**** +Descriptions of the APIs to the Non-RT RIC functions can be found in the repos for the functions. See Also: Non-RT RIC Control Panel ==================================