aboutsummaryrefslogtreecommitdiffstats
path: root/docs/data-router/architecture.rst
diff options
context:
space:
mode:
authorRam Koya <rk541m@att.com>2018-09-20 15:18:42 +0000
committerGerrit Code Review <gerrit@onap.org>2018-09-20 15:18:42 +0000
commite7045aa2c572410e4ab4143fc4c570a8826157e3 (patch)
tree96a6f1ab32a18a4ce04faa868e1598962a31fee7 /docs/data-router/architecture.rst
parent9c8a0690aa5a1e22332e78f685362af5b4a8fbe5 (diff)
parent8dde0cc7824e32f1a829b1528fa0e61a5707098f (diff)
Merge "User guide documentation for data router"
Diffstat (limited to 'docs/data-router/architecture.rst')
-rw-r--r--docs/data-router/architecture.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/data-router/architecture.rst b/docs/data-router/architecture.rst
new file mode 100644
index 00000000..b18f7bb3
--- /dev/null
+++ b/docs/data-router/architecture.rst
@@ -0,0 +1,25 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Architecture
+============
+
+
+Capabilities
+------------
+Data Router is a RESTful web service used for the transfer of data across networks any larger than a Message Router message (> 1Mb).
+
+Usage Scenarios
+---------------
+ Data Router endpoints are used to create/view/delete Feeds, Subscribers and Published files. Clients can use the Data Router endpoints
+ to publish a file to a feed and subscribe to this feed to receive the file.
+
+Interactions
+------------
+Data Router REST service uses the Data Router API to allow users to publish to and subscribe to a feed, in order to send and receive files.
+
+
+
+ |image0|
+
+ .. |image0| image:: dr_arch.png