docs/api-docs.rst

   1 ..  Copyright (c) 2019 AT&T Intellectual Property.
   2 ..  Copyright (c) 2019 Nokia.
   3 ..
   4 ..  Licensed under the Creative Commons Attribution 4.0 International
   5 ..  Public License (the "License"); you may not use this file except
   6 ..  in compliance with the License. You may obtain a copy of the License at
   7 ..
   8 ..    https://creativecommons.org/licenses/by/4.0/
   9 ..
  10 ..  Unless required by applicable law or agreed to in writing, documentation
  11 ..  distributed under the License is distributed on an "AS IS" BASIS,
  12 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 ..
  14 ..  See the License for the specific language governing permissions and
  15 ..  limitations under the License.
  16 ..
  17
  18
  19 API-Docs
  20 ========
  21
  22 This is the API-docs of ROUTING MANAGER
  23
  24 .. contents::
  25    :depth: 3
  26    :local:
  27
  28 .. note
  29
  30 .. This section is used to describe a software API exposed from a O-RAN software component.
  31
  32 .. This note must be removed after content has been added.
  33
  34
  35 API Introduction
  36 -----------------
  37 .. Please add what API a component have exposed.
  38
  39 API Functions
  40 -------------
  41 .. Please states the API functions.
  42