diff options
| author |   Emmett Cox <emmett.cox@ericsson.com> | 2018-09-17 10:25:09 +0100 |
|---|---|---|
| committer | Emmett Cox <emmett.cox@ericsson.com> | 2018-09-20 11:08:16 +0100 |
| commit | 8dde0cc7824e32f1a829b1528fa0e61a5707098f (patch) | |
| tree | e598401085707d6ed913f76b3e5a7171a5c8d4ca /docs/data-router/architecture.rst | |
| parent | 4e61cfafc9b10ca604b8e2c7ec0272246502fa82 (diff) | |
User guide documentation for data router
Change-Id: If28014e4f937c9036e22f2db7599fd8568f0c13f
Signed-off-by: Emmett Cox <emmett.cox@ericsson.com>
Issue-ID: DMAAP-552
Diffstat (limited to 'docs/data-router/architecture.rst')
| -rw-r--r-- | docs/data-router/architecture.rst | 25 |
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 |