Code Review / dmaap / datarouter.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
[DMAAP-DR] Doc updates for AAF and tlsEnabled
[dmaap/datarouter.git] / docs / apis / data-router-api.rst
diff --git a/docs/apis/data-router-api.rst b/docs/apis/data-router-api.rst
index 1604e62..0b1c0cb 100755 (executable)
--- a/docs/apis/data-router-api.rst
+++ b/docs/apis/data-router-api.rst
@@ -44,12 +44,6 @@ Specifies HTTP Headers, such as Content-Type, that define the parameters of the
 \r
 The HTTP Body contains the feed content when creating a feed.\r
 \r
-**HTTP Authorization**\r
-\r
-The user-id:password pair:\r
-\r
-* If AAF enabled:  A valid AAF AppId to be authenticated and authorized by the AAF CADI framework.\r
-* If Non AAF    :  When publishing or retracting a file, a valid `EID Object`_ with publish permissions.\r
 \r
 Create a Feed\r
 -------------\r
@@ -62,43 +56,35 @@ Create a Feed
 \r
 **Request Parameters:**\r
 \r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| Field                | Description                    | Param Type | Data Type        | MaxLen | Set By | Updatable? | Required |  Valid/Example Values         |\r
-+======================+================================+============+==================+========+========+============+==========+===============================+\r
-| name                 | Feed name                      | Body       | String           | <=20   | Client | N          | Y        |                               |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| version              | Feed version                   | Body       | String           | <=20   | Client | N          | Y        | v1.0.0                        |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| description          | Feed description               | Body       | String           | <=256  | Client | Y          | N        |                               |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| business description | Business description           | Body       | String           | <=256  | Client | Y          | N        |                               |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| authorization        | Information for authorizing    | Body       |`Auth Object`_    |        | Client | Y          | Y        |                               |\r
-|                      | publishing requests            |            |                  |        |        |            |          |                               |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| suspend              | Set to true if the feed is in  | Body       | Boolean          |        | Client | Y          | N        | * true                        |\r
-|                      | the suspended state            |            |                  |        |        |            |          | * false (default)             |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| group-id             | Auth group for feed management | Body       | Integer          |        | Client | Y          | N        | 0 (default)                   |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| aaf_instance         | The instance passed to aaf     | Body       | String           | <=256  | Client | N          | N        | legacy (default)              |\r
-|                      | during permission checks       |            |                  |        |        |            |          |                               |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| Content-Type         | To specify type of message     | Header     | String           |        | Client | N          | Y        | application/vnd.dmaap-dr.feed |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| publisher            | Publisher identity as passed   | Header     | String           | <=8    | DR     | N          | Y        | username                      |\r
-|                      | in X-DMAAP-DR-ON-BEHALF-OF at  |            |                  |        |        |            |          |                               |\r
-|                      | creation time                  |            |                  |        |        |            |          |                               |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| Authorization        | The user / AppId to be         | Header     | String           |        | Client | N          | Y if AAF | dcae@dcae.onap.org:{password} |\r
-|                      | authorized by the AAF CADI     |            |                  |        |        |            | enabled  |                               |\r
-|                      | framework                      |            |                  |        |        |            |          |                               |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| X-EXCLUDE-AAF        | To determine if the feed to    | Header     | Boolean          |        | Client | N          | Y if AAF | * true (for legacy feed)      |\r
-|                      | create is legacy or AAF        |            |                  |        |        |            | enabled  | * false (for AAF feed)        |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| Links                | URLs related to this feed      | Body       |`Feed Links Obj`_ |        | DR     | N          | N        |                               |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| Field                   | Description                    | Param Type | Data Type        | MaxLen | Set By | Updatable? | Required |  Valid/Example Values         |\r
++=========================+================================+============+==================+========+========+============+==========+===============================+\r
+| name                    | Feed name                      | Body       | String           | <=20   | Client | N          | Y        |                               |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| version                 | Feed version                   | Body       | String           | <=20   | Client | N          | Y        | v1.0.0                        |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| description             | Feed description               | Body       | String           | <=256  | Client | Y          | N        |                               |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| business description    | Business description           | Body       | String           | <=256  | Client | Y          | N        |                               |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| authorization           | Information for authorizing    | Body       |`Auth Object`_    |        | Client | Y          | Y        |                               |\r
+|                         | publishing requests            |            |                  |        |        |            |          |                               |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| suspend                 | Set to true if the feed is in  | Body       | Boolean          |        | Client | Y          | N        | * true                        |\r
+|                         | the suspended state            |            |                  |        |        |            |          | * false (default)             |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| group-id                | Auth group for feed management | Body       | Integer          |        | Client | Y          | N        | 0 (default)                   |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| Content-Type            | To specify type of message     | Header     | String           |        | Client | N          | Y        | application/vnd.dmaap-dr.feed |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| Authorization           | The user / AppId to be         | Header     | String           |        | Client | N          | Y        | Basic <credentials>           |\r
+|                         | authorized                     |            |                  |        |        |            |          |                               |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed   | Header     | String           | <=8    | DR     | N          | Y        | username                      |\r
+|                         | in X-DMAAP-DR-ON-BEHALF-OF at  |            |                  |        |        |            |          |                               |\r
+|                         | creation time                  |            |                  |        |        |            |          |                               |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+\r
 \r
 **Response Codes**\r
 \r
@@ -158,17 +144,12 @@ Create a Feed
           {\r
             "password": "dradmin",\r
             "id": "dradmin"\r
-          },\r
-          {\r
-            "password": "demo123456!",\r
-            "id": "onap"\r
           }\r
         ]\r
       },\r
       "name": "ONAP Data Feed",\r
       "business_description": "",\r
-      "aaf_instance": "legacy",\r
-      "publisher": "dradmin",\r
+      "publisher": "{user}",\r
       "links": {\r
         "subscribe": "https://dmaap-dr-prov/subscribe/1",\r
         "log": "https://dmaap-dr-prov/feedlog/1",\r
@@ -191,35 +172,34 @@ Update a Feed
 \r
 **Request Parameters:**\r
 \r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Field                  | Description                     |  Param Type |  Data Type    |  MaxLen    |  Required   |\r
-+========================+=================================+=============+===============+============+=============+\r
-| name                   | Feed name                       |     Body    |   String      |   <=20     |     Y       |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| description            | Feed description                |     Body    |   String      |   <=256    |     N       |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| business description   | Business description            |     Body    |   String      |   <=256    |     N       |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| authorization          | Information for authorizing     |     Body    |`Auth Object`_ |            |     Y       |\r
-|                        | publishing requests             |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| suspend                | Set to true if the feed is in   |     Body    |   Boolean     |            |     N       |\r
-|                        | the suspended state             |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| group-id               | Auth group for feed management  |     Body    |   Integer     |            |     N       |\r
-|                        |                                 |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Content-type           | To specify type of message      |    Header   |   String      |            |     Y       |\r
-|                        | (feed,subscriber,publisher)     |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| publisher              | Publisher identity as passed    |    Header   |   String      |   <=8      |     Y       |\r
-|                        | in X-DMAAP-DR-ON-BEHALF-OF at   |             |               |            |             |\r
-|                        | creation time                   |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Authorization          | The user / AppId to be          |    Header   |   String      |            | Y if AAF    |\r
-|                        | authorized by the AAF CADI      |             |               |            | enabled     |\r
-|                        | framework                       |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field                   | Description                     |  Param Type |  Data Type    |  MaxLen    |  Required   |\r
++=========================+=================================+=============+===============+============+=============+\r
+| name                    | Feed name                       |     Body    |   String      |   <=20     |     Y       |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| description             | Feed description                |     Body    |   String      |   <=256    |     N       |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| business description    | Business description            |     Body    |   String      |   <=256    |     N       |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| authorization           | Information for authorizing     |     Body    |`Auth Object`_ |            |     Y       |\r
+|                         | publishing requests             |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| suspend                 | Set to true if the feed is in   |     Body    |   Boolean     |            |     N       |\r
+|                         | the suspended state             |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| group-id                | Auth group for feed management  |     Body    |   Integer     |            |     N       |\r
+|                         |                                 |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Content-type            | To specify type of message      |    Header   |   String      |            |     Y       |\r
+|                         | (feed,subscriber,publisher)     |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Authorization           | The user / AppId to be          |    Header   |   String      |            |     Y       |\r
+|                         | authorized                      |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed    |    Header   |   String      | <=8        |     Y       |\r
+|                         | in X-DMAAP-DR-ON-BEHALF-OF at   |             |               |            |             |\r
+|                         | creation time                   |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
 \r
 **Response Codes**\r
 \r
@@ -295,8 +275,7 @@ Update a Feed
       },\r
       "name": "ONAP Data Feed1",\r
       "business_description": "Updated ONAP Feed",\r
-      "aaf_instance": "legacy",\r
-      "publisher": "dradmin",\r
+      "publisher": "{user}",\r
       "links": {\r
         "subscribe": "https://dmaap-dr-prov/subscribe/1",\r
         "log": "https://dmaap-dr-prov/feedlog/1",\r
@@ -319,17 +298,16 @@ Get a Feed
 \r
 **Request Parameters:**\r
 \r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Field                  | Description                     |  Param Type |  Data Type    |  MaxLen    |  Required   |\r
-+========================+=================================+=============+===============+============+=============+\r
-| publisher              | Publisher identity as passed    |    Header   |   String      |   <=8      |     Y       |\r
-|                        | in X-DMAAP-DR-ON-BEHALF-OF at   |             |               |            |             |\r
-|                        | creation time                   |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Authorization          | The user / AppId to be          |    Header   |   String      |            | Y if AAF    |\r
-|                        | authorized by the AAF CADI      |             |               |            | enabled     |\r
-|                        | framework                       |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field                   | Description                     |  Param Type |  Data Type    |  MaxLen    |  Required   |\r
++=========================+=================================+=============+===============+============+=============+\r
+| Authorization           | The user / AppId to be          |    Header   |   String      |            |     Y       |\r
+|                         | authorized                      |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed    |    Header   |   String      | <=8        |     Y       |\r
+|                         | in X-DMAAP-DR-ON-BEHALF-OF at   |             |               |            |             |\r
+|                         | creation time                   |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
 \r
 **Response Codes**\r
 \r
@@ -367,17 +345,12 @@ Get a Feed
           {\r
             "password": "dradmin",\r
             "id": "dradmin"\r
-          },\r
-          {\r
-            "password": "demo123456!",\r
-            "id": "onap"\r
           }\r
         ]\r
       },\r
       "name": "ONAP Data Feed",\r
       "business_description": "Updated ONAP Feed",\r
-      "aaf_instance": "legacy",\r
-      "publisher": "dradmin",\r
+      "publisher": "{user}",\r
       "links": {\r
         "subscribe": "https://dmaap-dr-prov/subscribe/1",\r
         "log": "https://dmaap-dr-prov/feedlog/1",\r
@@ -399,17 +372,16 @@ Delete a Feed
 \r
 **Request Parameters:**\r
 \r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Field                  | Description                     |  Param Type |  Data Type    |  MaxLen    |  Required   |\r
-+========================+=================================+=============+===============+============+=============+\r
-| publisher              | Publisher identity as passed    |    Header   |   String      |   <=8      |     Y       |\r
-|                        | in X-DMAAP-DR-ON-BEHALF-OF at   |             |               |            |             |\r
-|                        | creation time                   |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Authorization          | The user / AppId to be          |    Header   |   String      |            | Y if AAF    |\r
-|                        | authorized by the AAF CADI      |             |               |            | enabled     |\r
-|                        | framework                       |             |               |            |             |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field                   | Description                     |  Param Type |  Data Type    |  MaxLen    |  Required   |\r
++=========================+=================================+=============+===============+============+=============+\r
+| Authorization           | The user / AppId to be          |    Header   |   String      |            |     Y       |\r
+|                         | authorized                      |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed    |    Header   |   String      | <=8        |     Y       |\r
+|                         | in X-DMAAP-DR-ON-BEHALF-OF at   |             |               |            |             |\r
+|                         | creation time                   |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
 \r
 **Response Codes**\r
 \r
@@ -438,51 +410,40 @@ Subscribe to Feed
 \r
 **Request Parameters:**\r
 \r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| Field           | Description                     |  Param Type   |  Data Type      | MaxLen | Set By | Updatable? | Required |  Valid/Example Values                |\r
-+=================+=================================+===============+=================+========+========+============+==========+======================================+\r
-| feedId          | ID for the feed you are         |     Path      |   String        |        | Client |     N      |     Y    | 1                                    |\r
-|                 | subscribing to                  |               |                 |        |        |            |          |                                      |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| delivery        | Address and credentials for     |     Body      | `Del Object`_   |        | Client |     Y      |     Y    |                                      |\r
-|                 | delivery                        |               |                 |        |        |            |          |                                      |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| follow_redirect | Set to true if feed redirection |     Body      |   Boolean       |        | Client |     Y      |     N    | * true                               |\r
-|                 | is expected                     |               |                 |        |        |            |          | * false (default)                    |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| metadata_only   | Set to true if subscription is  |     Body      |   Boolean       |        | Client |     Y      |     Y    | * true                               |\r
-|                 | to receive per-file metadata    |               |                 |        |        |            |          | * false                              |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| suspend         | Set to true if the subscription |     Body      |   Boolean       |        | Client |     Y      |     N    | * true                               |\r
-|                 | is in the suspended state       |               |                 |        |        |            |          | * false (default)                    |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| decompress      | Set to true if the data is to   |     Body      |   Boolean       |        | Client |     Y      |     N    | * true                               |\r
-|                 | be decompressed for subscriber  |               |                 |        |        |            |          | * false (default)                    |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| group-id        | Auth group for sub management   |     Body      |   Integer       |        | Client |     Y      |     Y    | 22                                   |\r
-|                 |                                 |               |                 |        |        |            |          |                                      |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| aaf_instance    | The instance passed to aaf      |     Body      |   String        | <=256  | Client |     N      |     N    | * legacy (default)                   |\r
-|                 | during permission checks        |               |                 |        |        |            |          |                                      |\r
-|                 |                                 |               |                 |        |        |            |          |                                      |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| Content-type    | To specify type of message      |     Header    |   String        |        | Client |     N      |     Y    | application/vnd.dmaap-dr.subscription|\r
-|                 | (feed,subscriber,publisher)     |               |                 |        |        |            |          |                                      |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| subscriber      | Subscriber identity as passed   |     Header    |   String        |   <=8  |  DR    |     N      |     Y    | username                             |\r
-|                 | in X-DMAAP-DR-ON-BEHALF-OF at   |               |                 |        |        |            |          |                                      |\r
-|                 | creation time                   |               |                 |        |        |            |          |                                      |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| Authorization   | The user / AppId to be          |    Header     |   String        |        | Client |     N      | Y if AAF | dcae@dcae.onap.org:{password}        |\r
-|                 | authorized by the AAF CADI      |               |                 |        |        |            | enabled  |                                      |\r
-|                 | framework                       |               |                 |        |        |            |          |                                      |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| X-EXCLUDE-AAF   | To determine if the feed to     |    Header     |   Boolean       |        | Client |     N      | Y if AAF | * true (for legacy feed)             |\r
-|                 | create is legacy or AAF         |               |                 |        |        |            | enabled  | * false (for AAF feed)               |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| Links           | URLs related to this            |     Body      |`Sub Links Obj`_ |        |  DR    |     N      |     N    |                                      |\r
-|                 | subscription                    |               |                 |        |        |            |          |                                      |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| Field                   | Description                     |  Param Type   |  Data Type      | MaxLen | Set By | Updatable? | Required |  Valid/Example Values                |\r
++=========================+=================================+===============+=================+========+========+============+==========+======================================+\r
+| feedId                  | ID for the feed you are         |     Path      |   String        |        | Client |     N      |     Y    | 1                                    |\r
+|                         | subscribing to                  |               |                 |        |        |            |          |                                      |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| delivery                | Address and credentials for     |     Body      | `Del Object`_   |        | Client |     Y      |     Y    |                                      |\r
+|                         | delivery                        |               |                 |        |        |            |          |                                      |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| follow_redirect         | Set to true if feed redirection |     Body      |   Boolean       |        | Client |     Y      |     N    | * true                               |\r
+|                         | is expected                     |               |                 |        |        |            |          | * false (default)                    |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| metadata_only           | Set to true if subscription is  |     Body      |   Boolean       |        | Client |     Y      |     Y    | * true                               |\r
+|                         | to receive per-file metadata    |               |                 |        |        |            |          | * false                              |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| suspend                 | Set to true if the subscription |     Body      |   Boolean       |        | Client |     Y      |     N    | * true                               |\r
+|                         | is in the suspended state       |               |                 |        |        |            |          | * false (default)                    |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| decompress              | Set to true if the data is to   |     Body      |   Boolean       |        | Client |     Y      |     N    | * true                               |\r
+|                         | be decompressed for subscriber  |               |                 |        |        |            |          | * false (default)                    |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| group-id                | Auth group for sub management   |     Body      |   Integer       |        | Client |     Y      |     Y    | 22                                   |\r
+|                         |                                 |               |                 |        |        |            |          |                                      |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| Content-type            | To specify type of message      |     Header    |    String       |        | Client |     N      |     Y    | application/vnd.dmaap-dr.subscription|\r
+|                         | (feed,subscriber,publisher)     |               |                 |        |        |            |          |                                      |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| Authorization           | The user / AppId to be          |    Header     |    String       |        | Client | N          | Y        | Basic <credentials>                  |\r
+|                         | authorized                      |               |                 |        |        |            |          |                                      |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed    |    Header     |    String       | <=8    | DR     | N          | Y        | username                             |\r
+|                         | in X-DMAAP-DR-ON-BEHALF-OF at   |               |                 |        |        |            |          |                                      |\r
+|                         | creation time                   |               |                 |        |        |            |          |                                      |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
 \r
 **Response Codes**\r
 \r
@@ -535,12 +496,11 @@ Subscribe to Feed
         "user": "LOGIN",\r
         "url": "http://dmaap-dr-subscriber:7070/"\r
       },\r
-      "subscriber": "onap",\r
+      "subscriber": "{user}",\r
       "groupid": 1,\r
       "metadataOnly": false,\r
       "follow_redirect": true,\r
       "decompress": true,\r
-      "aaf_instance": "legacy",\r
       "links": {\r
         "feed": "https://dmaap-dr-prov/feed/1",\r
         "log": "https://dmaap-dr-prov/sublog/1",\r
@@ -563,44 +523,40 @@ Update subscription
 \r
 **Request Parameters:**\r
 \r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Field           | Description                     |  Param Type  |  Data Type    | MaxLen |  Required   |\r
-+=================+=================================+==============+===============+========+=============+\r
-| subId           | ID for the subscription you are |     Path     |   String      |        |     Y       |\r
-|                 | updating                        |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| delivery        | Address and credentials for     |     Body     | `Del Object`_ |        |     Y       |\r
-|                 | delivery                        |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| follow_redirect | Set to true if feed redirection |     Body     |   Boolean     |        |     N       |\r
-|                 | is expected                     |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| metadata_only   | Set to true if subscription is  |     Body     |   Boolean     |        |     Y       |\r
-|                 | to receive per-file metadata    |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| suspend         | Set to true if the subscription |     Body     |   Boolean     |        |     N       |\r
-|                 | is in the suspended state       |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| decompress      | Set to true if the data is to   |     Body     |   Boolean     |        |     N       |\r
-|                 | be decompressed for subscriber  |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| group-id        | Auth group for sub management   |     Body     |   Integer     |        |     Y       |\r
-|                 |                                 |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Content-type    | To specify type of message      |     Header   |   String      |        |     Y       |\r
-|                 | (feed,subscriber,publisher)     |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| subscriber      | Subscriber identity as passed   |     Header   |   String      |  <=8   |     Y       |\r
-|                 | in X-DMAAP-DR-ON-BEHALF-OF at   |              |               |        |             |\r
-|                 | creation time                   |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Authorization   | The user / AppId to be          |    Header    |   String      |        |  Y if AAF   |\r
-|                 | authorized by the AAF CADI      |              |               |        |  enabled    |\r
-|                 | framework                       |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| X-EXCLUDE-AAF   | To determine if the feed to     |    Header    |   Boolean     |        |  Y if AAF   |\r
-|                 | create is legacy or AAF         |              |               |        |  enabled    |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| Field                   | Description                     |  Param Type  |  Data Type    | MaxLen |  Required   |\r
++=========================+=================================+==============+===============+========+=============+\r
+| subId                   | ID for the subscription you are |     Path     |   String      |        |     Y       |\r
+|                         | updating                        |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| delivery                | Address and credentials for     |     Body     | `Del Object`_ |        |     Y       |\r
+|                         | delivery                        |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| follow_redirect         | Set to true if feed redirection |     Body     |   Boolean     |        |     N       |\r
+|                         | is expected                     |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| metadata_only           | Set to true if subscription is  |     Body     |   Boolean     |        |     Y       |\r
+|                         | to receive per-file metadata    |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| suspend                 | Set to true if the subscription |     Body     |   Boolean     |        |     N       |\r
+|                         | is in the suspended state       |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| decompress              | Set to true if the data is to   |     Body     |   Boolean     |        |     N       |\r
+|                         | be decompressed for subscriber  |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| group-id                | Auth group for sub management   |     Body     |   Integer     |        |     Y       |\r
+|                         |                                 |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| Content-type            | To specify type of message      |     Header   |   String      |        |     Y       |\r
+|                         | (feed,subscriber,publisher)     |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| Authorization           | The user / AppId to be          |    Header    |   String      |        |     Y       |\r
+|                         | authorized                      |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed    |    Header    |   String      | <=8    |     Y       |\r
+|                         | in X-DMAAP-DR-ON-BEHALF-OF at   |              |               |        |             |\r
+|                         | creation time                   |              |               |        |             |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
 \r
 **Response Codes**\r
 \r
@@ -652,12 +608,11 @@ Update subscription
         "user": "NEW_LOGIN",\r
         "url": "http://dmaap-dr-subscriber:7070/"\r
       },\r
-      "subscriber": "onap",\r
+      "subscriber": "{user}",\r
       "groupid": 67,\r
       "metadataOnly": true,\r
       "follow_redirect": false,\r
       "decompress": false,\r
-      "aaf_instance": "legacy",\r
       "links": {\r
         "feed": "https://dmaap-dr-prov/feed/1",\r
         "log": "https://dmaap-dr-prov/sublog/1",\r
@@ -680,17 +635,17 @@ Get a Subscription
 \r
 **Request Parameters:**\r
 \r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Field           | Description                     |  Param Type  |  Data Type    | MaxLen |  Required   |\r
-+=================+=================================+==============+===============+========+=============+\r
-| subscriber      | Subscriber identity as passed   |    Header    |   String      |  <=8   |     Y       |\r
-|                 | in X-DMAAP-DR-ON-BEHALF-OF at   |              |               |        |             |\r
-|                 | creation time                   |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Authorization   | The user / AppId to be          |    Header    |   String      |        |  Y if AAF   |\r
-|                 | authorized by the AAF CADI      |              |               |        |  enabled    |\r
-|                 | framework                       |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field                   | Description                     |  Param Type |  Data Type    |  MaxLen    |  Required   |\r
++=========================+=================================+=============+===============+============+=============+\r
+| Authorization           | The user / AppId to be          |    Header   |   String      |            |     Y       |\r
+|                         | authorized                      |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Subscriber identity as passed   |    Header   |   String      | <=8        |     Y       |\r
+|                         | in X-DMAAP-DR-ON-BEHALF-OF at   |             |               |            |             |\r
+|                         | creation time                   |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+\r
 \r
 **Response Codes**\r
 \r
@@ -721,13 +676,12 @@ Get a Subscription
         "user": "NEW_LOGIN",\r
         "url": "http://dmaap-dr-subscriber:7070/"\r
       },\r
-      "subscriber": "onap",\r
+      "subscriber": "{user}",\r
       "groupid": 67,\r
       "metadataOnly": true,\r
       "privilegedSubscriber": false,\r
       "follow_redirect": false,\r
       "decompress": false,\r
-      "aaf_instance": "legacy",\r
       "links": {\r
         "feed": "https://dmaap-dr-prov/feed/2",\r
         "log": "https://dmaap-dr-prov/sublog/6",\r
@@ -749,17 +703,16 @@ Delete a subscription
 \r
 **Request Parameters:**\r
 \r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Field           | Description                     |  Param Type  |  Data Type    | MaxLen |  Required   |\r
-+=================+=================================+==============+===============+========+=============+\r
-| subscriber      | Subscriber identity as passed   |     Header   |   String      |  <=8   |     Y       |\r
-|                 | in X-DMAAP-DR-ON-BEHALF-OF at   |              |               |        |             |\r
-|                 | creation time                   |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Authorization   | The user / AppId to be          |    Header    |   String      |        |  Y if AAF   |\r
-|                 | authorized by the AAF CADI      |              |               |        |  enabled    |\r
-|                 | framework                       |              |               |        |             |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field                   | Description                     |  Param Type |  Data Type    |  MaxLen    |  Required   |\r
++=========================+=================================+=============+===============+============+=============+\r
+| Authorization           | The user / AppId to be          |    Header   |   String      |            |     Y       |\r
+|                         | authorized                      |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Subscriber identity as passed   |    Header   |   String      | <=8        |     Y       |\r
+|                         | in X-DMAAP-DR-ON-BEHALF-OF at   |             |               |            |             |\r
+|                         | creation time                   |             |               |            |             |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
 \r
 **Response Codes**\r
 \r
@@ -809,10 +762,8 @@ Publish to Feed
 |                        | * Lowercase boolean             |                  |            |              |             |                                           |\r
 |                        | * null                          |                  |            |              |             |                                           |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+-------------------------------------------+\r
-| Authorization          | An `EID Object`_ with publish   |     Header       |  String    |              |     Y       | * (legacy Feed) dradmin:dradmin           |\r
-|                        | permissions.                    |                  |            |              |             | * (AAF Feed) dcae@dcae.onap.org:{password}|\r
-|                        | If AAF CADI is enabled, use a   |                  |            |              |             |                                           |\r
-|                        | valid AAF user/AppId instead.   |                  |            |              |             |                                           |\r
+| Authorization          | An `EID Object`_ with publish   |     Header       |  String    |              |     Y       | * dradmin:dradmin                         |\r
+|                        | permissions.                    |                  |            |              |             |                                           |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+-------------------------------------------+\r
 \r
 **Response Codes**\r
@@ -846,10 +797,8 @@ Delete/Retract a Published file
 +-----------------+---------------------------------+--------------+---------------+------------+-------------------------------------------+\r
 | Field           | Description                     |  Param Type  |  Data Type    | Required   |  Valid/Example Values                     |\r
 +=================+=================================+==============+===============+============+===========================================+\r
-| Authorization   | An `EID Object`_ with publish   |   Header     |    String     |    Y       | * (legacy Feed) dradmin:dradmin           |\r
-|                 | permissions.                    |              |               |            | * (AAF Feed) dcae@dcae.onap.org:{password}|\r
-|                 | If AAF CADI is enabled, use a   |              |               |            |                                           |\r
-|                 | valid AAF user/AppId instead.   |              |               |            |                                           |\r
+| Authorization   | An `EID Object`_ with publish   |   Header     |    String     |    Y       | * dradmin:dradmin                         |\r
+|                 | permissions.                    |              |               |            |                                           |\r
 +-----------------+---------------------------------+--------------+---------------+------------+-------------------------------------------+\r
 | feedId          | ID of the feed that was         |     Path     |    String     |    Y       |                                           |\r
 |                 | publishing to                   |              |               |            |                                           |\r
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. The interface to DR is exposed as a RESTful web service known as the DR Publishing and Delivery API