diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..f7dae490 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+
+============================================
+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: 3
+
+ data-router/data-router
+
+
|