Fix licensing issues

[ric-plt/nodeb-rnib.git] / docs / api-docs.rst

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
new file mode 100644 (file)
index 0000000..832b4b3
--- /dev/null
+++ b/docs/api-docs.rst
@@ -0,0 +1,41 @@
+.. 
+..  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.
+..
+
+
+.. contents::
+   :depth: 3
+   :local:
+
+API-docs
+============
+
+.. 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.
+