X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=db23bcaf7213d130a751a821d74e3bfdce7e9215;hb=b2ef1d832b94af02c7a3acefb4c8c5e4db03242b;hp=ef234a5661f603c785a6530598865c737fea4b4c;hpb=6feeffdf7069bdea16dc5e9731afc5e72bc6213d;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index ef234a56..db23bcaf 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,67 +1,15 @@ .. 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 ======== -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 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 `ONAP docs `_ and `wiki `_. - -Enrichment Coordinator Service -============================== - -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 - - "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) -================================== - -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 ==================================