Update index documentation file for Datarouter

[dmaap/datarouter.git] / docs / data-router / data-router.rst

diff --git a/docs/data-router/data-router.rst b/docs/data-router/data-router.rst
new file mode 100644 (file)
index 0000000..16f44ba
--- /dev/null
+++ b/docs/data-router/data-router.rst
@@ -0,0 +1,73 @@
+============================================\r
+Data Router (DR) API Guide\r
+============================================\r
+Introduction\r
+------------------\r
+\r
+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.\r
+\r
+\r
+HTTP Service APIs\r
+------------------\r
+\r
+DMaaP Message Router utilizes an HTTP REST API to service all transactions. HTTP and REST standards are followed so\r
+clients as varied as CURL, Java applications and even Web Browsers will\r
+work to interact with the Data Router.\r
+\r
+General HTTP Requirements\r
+=========================\r
+\r
+A DMaaP Message Router transactions consists of 4 distinct segments,\r
+HTTP URL, HTTP Header, HTTP Body (POST/PUT) and HTTP Response. The general\r
+considerations for each segment are as follows and are required for each\r
+of the specific transactions described in this section.\r
+\r
+HTTP URL\r
+========\r
+\r
+http[s]://serverBaseURL/{resourcePath}\r
+\r
+\r
+HTTP Header\r
+===========\r
+\r
+Specifies HTTP Headers, such as Content-Type, that define the parameters\r
+of the HTTP Transaction\r
+\r
+HTTP Body\r
+=========\r
+\r
+The HTTP Body contains the topic content when Publishing or Consuming.\r
+The Body may contain topic messages in several formats (like below) but\r
+it must be noted, that, except in very specific circumstances, messages\r
+are not inspected for content.\r
+\r
+Create a Feed\r
+-----------\r
+\r
+**Description**:Creates the feed\r
+\r
+Sample Request\r
+==============\r
+\r
+curl -v -X POST -H "Content-Type : application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: rs873m" --data-ascii @/opt/app/datartr/addFeed3.txt --post301 --location-trusted -k https://prov.datarouternew.com:8443\r
+\r
+Subscribe to Feed\r
+-----------\r
+\r
+curl -v -X POST -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: rs873m" --data-ascii @/opt/app/datartr/addSubscriber.txt --post301 --location-trusted -k https://prov.datarouternew.com:8443/subscribe/1\r
+\r
+Sample Request\r
+==============\r
+\r
+POST http(s)://{HOST:PORT}/events/{topicname}\r
+\r
+Publish to feed\r
+-----------\r
+\r
+**Description**:publish  the feed\r
+\r
+Sample Request\r
+==============\r
+\r
+curl -v -X PUT --user rs873m:rs873m -H "Content-Type: application/octet-stream" --data-binary @/opt/app/datartr/addFeed3.txt --post301 --location-trusted -k https://prov.datarouternew.com:8443/publish/1/test1\r