X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;fp=docs%2Fapi-docs.rst;h=882f99addc69b4514119d1a9dba7733b74b77e89;hb=d909bf02dce0e0325ee25d612cf989f3aa59b45b;hp=0000000000000000000000000000000000000000;hpb=57d8540765fc4d6e4b66cd9d100c564866d3f0f9;p=ric-plt%2Frtmgr.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst new file mode 100644 index 0000000..882f99a --- /dev/null +++ b/docs/api-docs.rst @@ -0,0 +1,42 @@ +.. Copyright (c) 2019 AT&T Intellectual Property. +.. Copyright (c) 2019 Nokia. +.. +.. Licensed under the Creative Commons Attribution 4.0 International +.. Public License (the "License"); you may not use this file except +.. in compliance with the License. You may obtain a copy of the License at +.. +.. https://creativecommons.org/licenses/by/4.0/ +.. +.. Unless required by applicable law or agreed to in writing, documentation +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + + +API-Docs +======== + +This is the API-docs of ROUTING MANAGER + +.. contents:: + :depth: 3 + :local: + +.. note + +.. This section is used to describe a software API exposed from a O-RAN software component. + +.. This note must be removed after content has been added. + + +API Introduction +----------------- +.. Please add what API a component have exposed. + +API Functions +------------- +.. Please states the API functions. +