X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=db23bcaf7213d130a751a821d74e3bfdce7e9215;hb=b2ef1d832b94af02c7a3acefb4c8c5e4db03242b;hp=a4cdf08a5bc9d9f68dd140b5bf31c05da734f092;hpb=f217fffad3db72759708ea68892357b46b8ed4a0;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index a4cdf08a..db23bcaf 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,50 +1,34 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2021 Nordix + +.. _api_docs: ======== API-Docs ======== -This is the API-docs of Non-RT RIC. - -.. contents:: - :depth: 3 - :local: - -The Non-RT RIC consists of two parts, described in the sections below: - * The Policy Agent - * The SDNC A1 Controller - +Descriptions of the APIs to the Non-RT RIC functions can be found in the repos for the functions. -Policy Agent -============ +See Also: Non-RT RIC Control Panel +================================== -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. - -See the README.md file in the nonrtric/policy-agent repo for info about how to use it. +The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC. -API Functions -------------- -See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml +Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel `_. -SDNC A1 Controller -================== +It can be downloaded from here: :: -An ONAP SDNC Controller for the A1 interface. + git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel". -See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. +See Also: A1 / Near-RT RIC simulator +==================================== -Complementary tools -=================== +The Near-RT RIC simulator simulates an A1 protocol termination endpoint. -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. +Documentation for the simulator can be found here: `A1 Interface Simulator `_. -The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC. -It can be downloaded using: git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel" +It can be downloaded from here: :: -The Near-RT RIC simulator does what its name suggests, and can be downloaded here: git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface" + git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"