docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
   2 .. http://creativecommons.org/licenses/by/4.0\r
   3 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   4 \r
   5 ============================================\r
   6 Data Router (DR) API Guide\r
   7 ============================================\r
   8 Introduction\r
   9 ------------------\r
  10 \r
  11 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
  12 \r
  13 \r
  14 HTTP Service APIs\r
  15 ------------------\r
  16 \r
  17 DMaaP Data Router utilizes an HTTPS REST API to service all transactions. HTTPS and REST standards are followed so\r
  18 clients as varied as CURL, Java applications and even Web Browsers will work to interact with the Data Router.\r
  19 \r
  20 \r
  21 \r
  22 .. toctree::\r
  23    :maxdepth: 1\r
  24    \r
  25    data-router/data-router.rst\r
  26    data-router/administration.rst\r
  27    data-router/architecture.rst\r
  28    data-router/configuration.rst\r
  29    data-router/consumedapis.rst\r
  30    data-router/DataRouterUserGuide.rst\r
  31    data-router/delivery.rst\r
  32    data-router/humaninterfaces.rst\r
  33    data-router/logging.rst\r
  34    data-router/release-notes.rst\r
  35 \r
  36 \r
  37 \r