X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=99f0f2815d26db7b45737b9fa07c2153459f9100;hb=233898bab542c5425af9f6240955bad3904f9838;hp=77b53fb43e1c93b45cb46a8daf7f02d2f3714edb;hpb=f860d6dfd31f59b79c70912ca2130b8d53a1e3c5;p=dmaap%2Fdatarouter.git diff --git a/docs/index.rst b/docs/index.rst index 77b53fb4..99f0f281 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,14 +2,36 @@ .. 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 Data Router utilizes an HTTPS REST API to service all transactions. HTTPS 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: 1 - data-router/data-router + data-router/data-router.rst + data-router/administration.rst + data-router/architecture.rst + data-router/configuration.rst + data-router/consumedapis.rst + data-router/DataRouterUserGuide.rst + data-router/delivery.rst + data-router/humaninterfaces.rst + data-router/logging.rst + data-router/release-notes.rst +