Adding documentation files. Only the release notes file is actually relevant.

[ric-plt/asn1-documents.git] / docs / api-docs.rst

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
new file mode 100644 (file)
index 0000000..087b592
--- /dev/null
+++ b/docs/api-docs.rst
@@ -0,0 +1,28 @@
+.. 
+..  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
+============
+
+The API (ASN.1 definitions) ae defined in the E2AP document and a copy of the ASN.1 is in the ASN.1 file of 
+this repository. This is the version of the E2 that the near-RT RIC platform is implemented against.
+