X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=7c6b6c2561c423e16af63db66bc5715098ed37d5;hb=2918bef3d237c99e6cf7e9c1ab1722781128617b;hp=ef234a5661f603c785a6530598865c737fea4b4c;hpb=02a72fd14966d3a7f26e6ef93f1a045607348f14;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index ef234a56..7c6b6c25 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,6 +1,6 @@ .. 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: @@ -20,8 +20,8 @@ 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 +* The Information Coordinator Service +* DMaaP Adaptor * K8S Helm Chart LCM Manager (Initial) **** A1 Policy Management Service @@ -29,10 +29,10 @@ 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 -============================== +Information Coordinator Service +=============================== -See `A1 Enrichment Information Coordination Service API <./ecs-api.html>`_ for full details of the API. +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: @@ -40,14 +40,14 @@ The API is also described in Swagger-JSON and YAML: :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>`" + "A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`" -Non-RT-RIC App Catalogue (Initial) -================================== +DMaaP Adaptor +============= -The Service Catalogue provides a way for services to register themselves for other services to discover. +The DMaaP Adaptor provides support for push delivery of any data received from DMaaP or Kafka. -See `Service Catalogue API <./rac-api.html>`_ for full details of the API. +See `DMaaP Adaptor API <./dmaap-adaptor-api.html>`_ for full details of the API. The API is also described in Swagger-JSON and YAML: @@ -56,7 +56,7 @@ The API is also described in Swagger-JSON and YAML: :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>`" + "DMaaP Adaptor API", ":download:`link <../dmaap-adaptor-java/api/api.json>`", ":download:`link <../dmaap-adaptor-java/api/api.yaml>`" K8S Helm Chart LCM Manager (Initial) ====================================