From ccdc64e1b1df89513b423eff51c8614c3ccf4c4f Mon Sep 17 00:00:00 2001 From: HuabingZhao Date: Wed, 27 Sep 2017 21:59:06 +0800 Subject: Add api docs for MSB Issue-Id: MSB-79 Change-Id: I07de7b05d0b278eae23a5640368dec4cd619ee3d Signed-off-by: HuabingZhao --- docs/index.rst | 15 ++++++++++++++- docs/offeredapis.rst | 12 ++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/offeredapis.rst diff --git a/docs/index.rst b/docs/index.rst index 833e1aa..8219c32 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 index 0000000..3ceed0c --- /dev/null +++ b/docs/offeredapis.rst @@ -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 `_. +- `Swagger SDK `_. \ No newline at end of file -- cgit 1.2.3-korg