Add api docs for MSB 01/16001/2
authorHuabingZhao <zhao.huabing@zte.com.cn>
Wed, 27 Sep 2017 13:59:06 +0000 (21:59 +0800)
committerHuabingZhao <zhao.huabing@zte.com.cn>
Wed, 27 Sep 2017 14:07:01 +0000 (22:07 +0800)
Issue-Id: MSB-79
Change-Id: I07de7b05d0b278eae23a5640368dec4cd619ee3d
Signed-off-by: HuabingZhao <zhao.huabing@zte.com.cn>
docs/index.rst
docs/offeredapis.rst [new file with mode: 0644]

index 833e1aa..8219c32 100644 (file)
@@ -1,8 +1,21 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
-TODO Add files to toctree and delete this header
+MSB(Microservices Bus)
 ------------------------------------------------
+
+Microservices Bus provide key infrastructure functionalities to support ONAP microservice architecture including service registration/discovery, service gateway, service load balancer and service governance. It's a pluggable architecture so it can be extended with plugins to provide value added services such as centralized authentication for APIs. Microservices Platform also provides a GUI portal for service management.
+
+MSB comprises these modules: 
+
+- MSB
+    - Discovery
+    - API Gateway
+    - MSB SDK
+    - Swagger SDK
+
 .. toctree::
    :maxdepth: 1
+   
+   offeredapis.rst
 
 
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100644 (file)
index 0000000..3ceed0c
--- /dev/null
@@ -0,0 +1,12 @@
+MSB APIs
+==================================
+The MSB provides the following APIs.
+
+* Service Registration/Unregistration
+* Service Update
+* Service Discovery
+* MSB Java SDK
+* Swagger SDK
+
+- `MSB APIs <https://wiki.onap.org/display/DW/Microservice+Bus+API+Documentation>`_.
+- `Swagger SDK <https://wiki.onap.org/display/DW/swagger-sdk>`_.
\ No newline at end of file