From bcf88dca55b8201dd5a47b54f08afe8d4166f569 Mon Sep 17 00:00:00 2001 From: Sripad Date: Tue, 13 Feb 2018 16:53:35 +0000 Subject: Update documentation file & sonar plugin Issue-ID: DMAAP-109 Change-Id: Ifb68600de75622791eba4fb3e9b472b39850afec Signed-off-by: Sai Gandham --- docs/index.rst | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) (limited to 'docs') 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 -- cgit 1.2.3-korg