diff options
| author |   Sripad <sg481n@att.com> | 2018-02-13 16:53:35 +0000 |
|---|---|---|
| committer | Sripad <sg481n@att.com> | 2018-02-13 16:53:41 +0000 |
| commit | bcf88dca55b8201dd5a47b54f08afe8d4166f569 (patch) | |
| tree | 7452772758f801524f83ec250c9bcdb11cf9a243 /docs | |
| parent | f860d6dfd31f59b79c70912ca2130b8d53a1e3c5 (diff) | |
Update documentation file & sonar plugin
Issue-ID: DMAAP-109
Change-Id: Ifb68600de75622791eba4fb3e9b472b39850afec
Signed-off-by: Sai Gandham <sg481n@att.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst index 77b53fb4..f7dae490 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,13 +2,26 @@ .. http://creativecommons.org/licenses/by/4.0
.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
-Message Router (MR)
-====================
+============================================
+Data Router (DR) API Guide
+============================================
+Introduction
+------------------
+
+The DataRouter(DR)provisioning API is an HTTPS-based,REST-like API for creating and managing DR feeds and subscriptions. The Data Routing System project is intended to provide a common framework by which data producers can make data available to data consumers and a way for potential consumers to find feeds with the data they require.
+
+
+HTTP Service APIs
+------------------
+
+DMaaP Message Router utilizes an HTTP REST API to service all transactions. HTTP and REST standards are followed so
+clients as varied as CURL, Java applications and even Web Browsers will
+work to interact with the Data Router.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 3
data-router/data-router
|