docs/api-docs.rst

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