From: lizi00164331
Date: Mon, 25 Sep 2017 09:09:53 +0000 (+0800)
Subject: Add the document file for esr-server.
X-Git-Tag: v1.0.0~22
X-Git-Url: https://gerrit.onap.org/r/gitweb?p=aai%2Fesr-server.git;a=commitdiff_plain;h=d9c27be95d4a3f61a5c2e77722162bd939e30858;hp=90efb9e11e77ce4f0a58fccfd7488a432b989596
Add the document file for esr-server.
Change-Id: Id2b8f1d87e08fc793459da01ed358a84e59430d9
Issue-ID: AAI-379
Signed-off-by: lizi00164331
---
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..f101744
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+AAI-esr-server
+------------------------------------------------
+
+ESR provide a way to register external system which not included in ONAP system, mainly inclouded VIM/VNFM/EMS/thirdparty SDNC. esr-server as the backend of exteral system register service mainly include the system register information preprocessing, system available check.
+
+ESR comprises two modules: the esr server module and the esr gui module. And both esr service and esr gui belongs A&AI.
+
+- AAI
+ - ESR server Module
+ - ESR gui Module
+
+.. toctree::
+ :maxdepth: 1
+
+ offeredapis.rst
+
+
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100644
index 0000000..8f33185
--- /dev/null
+++ b/docs/offeredapis.rst
@@ -0,0 +1,22 @@
+ESR server Component Offered APIs
+==================================
+The esr server module provides the following APIs.
+
+* VIM register
+* VIM query
+* VIM update
+* VIM Deletion
+* VNFM register
+* VNFM query
+* VNFM update
+* VNFM Deletion
+* EMS register
+* EMS query
+* EMS update
+* EMS Deletion
+* thirdparty SDNC register
+* thirdparty SDNC query
+* thirdparty SDNC update
+* thirdparty SDNC Deletion
+
+