Fix the typos in esr-server 53/41853/2
authorLiZi <li.zi30@zte.com.cn>
Tue, 10 Apr 2018 01:20:46 +0000 (21:20 -0400)
committerLiZi <li.zi30@zte.com.cn>
Tue, 10 Apr 2018 01:29:16 +0000 (21:29 -0400)
Change-Id: I5f27f955e89ec4417b46c0042bb6843985864bfe
Issue-ID: DOC-258
Signed-off-by: LiZi <li.zi30@zte.com.cn>
docs/index.rst
docs/offeredapis.rst [new file with mode: 0644]
docs/platform/consumedapis.rst
docs/platform/installation.rst
docs/release-notes/bug-fixes.rst
docs/release-notes/new-features.rst

index 2e9d3a8..6b68c45 100644 (file)
@@ -3,7 +3,7 @@
 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 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 external 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.
 
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100644 (file)
index 0000000..8f33185
--- /dev/null
@@ -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
+
+
index 2a8ce7c..9d64a9b 100644 (file)
@@ -56,7 +56,7 @@ More details could be found at `A&AI APIs <https://wiki.onap.org/pages/viewpage.
 Multi-Cloud
 ^^^^^^^^^^^
 
-ESR will call the API from Multi-Cloud to update the cloud-region infomation after put the VIM data to A&AI.
+ESR will call the API from Multi-Cloud to update the cloud-region information after put the VIM data to A&AI.
 
 #. Update VIM Info:
 
index 687f19c..6959d04 100644 (file)
@@ -34,7 +34,7 @@ sudo docker run -p  9519:8080 -d --net=host --name esr-gui nexus3.onap.org:10001
 Check status of ESR
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-Test whether esr-server is runing:
+Test whether esr-server is running:
 
 GET  http://ESR_SERVICE_IP:9518/api/aai-esr-server/v1/test 
 
index 45a8ace..784db32 100644 (file)
@@ -17,7 +17,7 @@ Bug
 * [AAI-225] - aai/esr-server daily build failed
 * [AAI-278] - AAI throws exception about mismatch keys adding esr-system-info to cloud-region
 * [AAI-377] - esr-gui docker build failed
-* [AAI-393] - The jjb defiend in a error way that cause CSIT build failed.
+* [AAI-393] - The jjb defined in a error way that cause CSIT build failed.
 * [AAI-398] - If a cloud-region didn't contain a external system info, there will be an null pointer error
 * [AAI-400] - Register ServiceTest to microservice
 * [AAI-407] - There is an error to startup esr-gui docker
index 6109ccc..4dbd09f 100644 (file)
@@ -33,7 +33,7 @@ Story
 Task
 ^^^^
 
-* [AAI-67] - Upload the server-end seed code to ONAP repostory
+* [AAI-67] - Upload the server-end seed code to ONAP repository
 * [AAI-68] - Upload the ESR gui seed code to ONAP repository
 * [AAI-69] - Remove the original SDNC related function from Amsterdan release.
 * [AAI-70] - Collect the schema of ESR for ONAP in Amsterdam release
@@ -109,7 +109,7 @@ Task
 * [AAI-358] - Change util method from static to unstatic
 * [AAI-359] - Fix the return data of del and query list API
 * [AAI-360] - Realize delete vim API
-* [AAI-361] - Update VIM after register finishied.
+* [AAI-361] - Update VIM after register finished.
 * [AAI-362] - Clean the Config files
 * [AAI-363] - Add unit test for app configuration
 * [AAI-365] - change the objectToString method to un-static