Bug fix for readTheDocs 92/76192/4
authorefiacor <fiachra.corcoran@est.tech>
Wed, 23 Jan 2019 16:11:28 +0000 (16:11 +0000)
committerefiacor <fiachra.corcoran@est.tech>
Wed, 23 Jan 2019 16:11:28 +0000 (16:11 +0000)
Change-Id: Ief3eb05307fe18433e03565febd995ae37fd7c82
Issue-ID: DMAAP-976
Signed-off-by: efiacor <fiachra.corcoran@est.tech>
docs/data-router/data-router.rst

index 39d61e1..cd466a7 100755 (executable)
@@ -7,7 +7,7 @@ Introduction
 ------------\r
 \r
 The DataRouter(DR) provisioning API is an HTTPS-based, REST-like API for creating and managing DR feeds\r
 ------------\r
 \r
 The DataRouter(DR) provisioning API is an HTTPS-based, REST-like API for creating and managing DR feeds\r
-and subscriptions. The Data Routing System project is intended to provide a common framework by which\r
+and subscriptions. The DMaaP Data Router System project is intended to provide a common framework by which\r
 data producers can make data available to data consumers and a way for potential consumers to find feeds\r
 with the data they require.\r
 \r
 data producers can make data available to data consumers and a way for potential consumers to find feeds\r
 with the data they require.\r
 \r
@@ -16,15 +16,13 @@ HTTP Service APIs
 -----------------\r
 \r
 DMaaP Data Router utilizes an HTTP REST API to service all transactions. HTTP and REST standards are followed so\r
 -----------------\r
 \r
 DMaaP Data 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
+clients as varied as CURL, Java applications and even Web Browsers will work to interact with the Data Router.\r
 \r
 General HTTP Requirements\r
 =========================\r
 \r
 \r
 General HTTP Requirements\r
 =========================\r
 \r
-A DMaaP Data 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
+A DMaaP Data Router transactions consists of 4 distinct segments, HTTP URL, HTTP Header, HTTP Body (POST/PUT)\r
+and HTTP Response. The general 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
 of the specific transactions described in this section.\r
 \r
 HTTP URL\r
@@ -32,8 +30,8 @@ HTTP URL
 \r
 http[s]://{serverBaseURL}/{resourcePath}\r
 \r
 \r
 http[s]://{serverBaseURL}/{resourcePath}\r
 \r
-* The serverBaseURL points to DMaaP Data Router host/port that will service the request.\r
-* The resourcePath specifies the specific service that the client is attempting to reach.\r
+* The serverBaseURL points to DMaaP Data Router host:port that will service the request.\r
+* The resourcePath specifies the service that the client is attempting to reach.\r
 \r
 \r
 HTTP Header\r
 \r
 \r
 HTTP Header\r
@@ -49,12 +47,12 @@ The HTTP Body contains the feed content when creating a feed.
 Create a Feed\r
 -------------\r
 \r
 Create a Feed\r
 -------------\r
 \r
-**Description**: Creates a unique set of URL's to service the publisher/subscriber model.\r
+**Description**: Creates a unique feed URL to service the publisher/subscriber model.\r
 \r
 Sample Request\r
 ==============\r
 \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: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --post301 --location-trusted -k https:/{host}:{port}``\r
+``curl -k -X POST -H "Content-Type:application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF:{user}" --data-ascii @createFeed.json https://{host}:{port}``\r
 \r
 Request Parameters:\r
 ===================\r
 \r
 Request Parameters:\r
 ===================\r
@@ -82,7 +80,7 @@ Request Parameters:
 | content-type           | To specify type of message      |     Header       |   String   |              |     Y       | application/vnd.att-dr.feed          |\r
 |                        | (feed,subscriber,publisher)     |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | content-type           | To specify type of message      |     Header       |   String   |              |     Y       | application/vnd.att-dr.feed          |\r
 |                        | (feed,subscriber,publisher)     |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF  | User id of owner of feed        |     Header       |   String   |     8        |     Y       |  username                            |\r
+| X-ATT-DR-ON-BEHALF-OF  | User id of owner of feed        |     Header       |   String   |     <=8      |     Y       |  username                            |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
@@ -142,27 +140,24 @@ Sample Body
 \r
  {\r
      "name": "Jettydemo",\r
 \r
  {\r
      "name": "Jettydemo",\r
-     "version": "m1.0",\r
+     "version": "v1.0.0",\r
      "description": "Jettydemo",\r
      "business_description": "Jettydemo",\r
      "suspend": false,\r
      "description": "Jettydemo",\r
      "business_description": "Jettydemo",\r
      "suspend": false,\r
-     "deleted": false,\r
      "changeowner": true,\r
      "authorization": {\r
           "classification": "unclassified",\r
      "changeowner": true,\r
      "authorization": {\r
           "classification": "unclassified",\r
-          "endpoint_addrs": [\r
-               "172.18.0.3",\r
-            ],\r
+          "endpoint_addrs": ["172.18.0.3","192.167.3.42"],\r
           "endpoint_ids": [\r
                {\r
                     "password": "password",\r
                     "id": "user"\r
                }\r
           ]\r
           "endpoint_ids": [\r
                {\r
                     "password": "password",\r
                     "id": "user"\r
                }\r
           ]\r
-     },\r
-\r
+     }\r
  }\r
 \r
  }\r
 \r
+\r
 Updating a Feed\r
 ---------------\r
 \r
 Updating a Feed\r
 ---------------\r
 \r
@@ -171,7 +166,7 @@ Updating a Feed
 Sample Request\r
 ==============\r
 \r
 Sample Request\r
 ==============\r
 \r
-``curl -v -X PUT -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --location-trusted -k https:/{host}:{port}``\r
+``curl -k -X PUT -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @updateFeed.json --location-trusted https://{host}:{port}/feed/{feedId}``\r
 \r
 Request Parameters:\r
 ===================\r
 \r
 Request Parameters:\r
 ===================\r
@@ -195,7 +190,7 @@ Request Parameters:
 | content-type           | To specify type of message      |     Header       |   String   |              |     Y       | application/vnd.att-dr.feed          |\r
 |                        | (feed,subscriber,publisher)     |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | content-type           | To specify type of message      |     Header       |   String   |              |     Y       | application/vnd.att-dr.feed          |\r
 |                        | (feed,subscriber,publisher)     |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF  | User id of owner of feed        |     Header       |   String   |     8        |     Y       |  username                            |\r
+| X-ATT-DR-ON-BEHALF-OF  | User id of owner of feed        |     Header       |   String   |     <=8      |     Y       |  username                            |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
@@ -255,27 +250,24 @@ Sample Body
 \r
  {\r
      "name": "Jettydemo",\r
 \r
  {\r
      "name": "Jettydemo",\r
-     "version": "m1.0",\r
-     "description": "Jettydemo",\r
-     "business_description": "Jettydemo",\r
+     "version": "v1.0.0",\r
+     "description": "Updated decription",\r
+     "business_description": "Updated business description",\r
      "suspend": false,\r
      "suspend": false,\r
-     "deleted": false,\r
      "changeowner": true,\r
      "authorization": {\r
           "classification": "unclassified",\r
      "changeowner": true,\r
      "authorization": {\r
           "classification": "unclassified",\r
-          "endpoint_addrs": [\r
-               "172.18.0.3",\r
-            ],\r
+          "endpoint_addrs": ["172.18.0.3","192.167.3.42"],\r
           "endpoint_ids": [\r
                {\r
                     "password": "password",\r
                     "id": "user"\r
                }\r
           ]\r
           "endpoint_ids": [\r
                {\r
                     "password": "password",\r
                     "id": "user"\r
                }\r
           ]\r
-     },\r
-\r
+     }\r
  }\r
 \r
  }\r
 \r
+\r
 Get a Feed\r
 ----------\r
 \r
 Get a Feed\r
 ----------\r
 \r
@@ -291,7 +283,7 @@ http[s]://{host}:{port}/feed/{feedId}
 Sample Request\r
 ==============\r
 \r
 Sample Request\r
 ==============\r
 \r
-``curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}``\r
+``curl -k -H "X-ATT-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}``\r
 \r
 Response/Error Codes\r
 ====================\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -352,7 +344,7 @@ http[s]://{host}:{port}/feed/{feedId}
 Sample Request\r
 ==============\r
 \r
 Sample Request\r
 ==============\r
 \r
-``curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}``\r
+``curl -k -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}``\r
 \r
 Response/Error Codes\r
 ====================\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -409,10 +401,12 @@ Request URL
 \r
 http[s]://{host}:{port}/subscribe/{feedId}\r
 \r
 \r
 http[s]://{host}:{port}/subscribe/{feedId}\r
 \r
+* {feedId}: Id of the feed to subscribe to\r
+\r
 Sample Request\r
 ==============\r
 \r
 Sample Request\r
 ==============\r
 \r
-``curl -v -X POST -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --post301 --location-trusted -k https://{host}:{port}/subscribe/{feedId}``\r
+``curl -k -X POST -H "Content-Type:application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF:{user}" --data-ascii @addSubscriber.json https://{host}:{port}/subscribe/{feedId}``\r
 \r
 Request Parameters:\r
 ===================\r
 \r
 Request Parameters:\r
 ===================\r
@@ -441,7 +435,7 @@ Request Parameters:
 | content-type           | To specify type of message      |     Header       |   String   |              |     Y       | application/vnd.att-dr.subscription  |\r
 |                        | (feed,subscriber,publisher)     |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | content-type           | To specify type of message      |     Header       |   String   |              |     Y       | application/vnd.att-dr.subscription  |\r
 |                        | (feed,subscriber,publisher)     |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF  | User id of subscriber           |     Header       |   String   |     8        |     Y       |  username                            |\r
+| X-ATT-DR-ON-BEHALF-OF  | User id of subscriber           |     Header       |   String   |     <=8      |     Y       |  username                            |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
@@ -507,10 +501,8 @@ Sample Body
         "use100" : true\r
     },\r
     "metadataOnly" : false,\r
         "use100" : true\r
     },\r
     "metadataOnly" : false,\r
-    "suspend" : false,\r
-    "groupid" : 29,\r
-    "subscriber" : "subscriber123"\r
-\r
+    "groupid" : 1,\r
+    "subscriber" : "subuser"\r
  }\r
 \r
 Update subscription\r
  }\r
 \r
 Update subscription\r
@@ -521,12 +513,14 @@ Update subscription
 Request URL\r
 ===========\r
 \r
 Request URL\r
 ===========\r
 \r
-http[s]://{host}:{port}/subscribe/{feedId}\r
+http[s]://{host}:{port}/subs/{subId}\r
+\r
+* {subId}: Id of the subscription to be updated\r
 \r
 Sample Request\r
 ==============\r
 \r
 \r
 Sample Request\r
 ==============\r
 \r
-``curl -v -X PUT -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --location-trusted -k https://{host}:{port}/subscribe/{feedId}``\r
+``curl -k -X PUT -H "Content-Type:application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF:{user}" --data-ascii @updateSubscriber.json https://{host}:{port}/subs/{subId}``\r
 \r
 Request Parameters:\r
 ===================\r
 \r
 Request Parameters:\r
 ===================\r
@@ -534,7 +528,7 @@ Request Parameters:
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                |\r
 +========================+=================================+==================+============+==============+=============+======================================+\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                |\r
 +========================+=================================+==================+============+==============+=============+======================================+\r
-| feedId                 | ID for the subscription you are |     Path         |   String   |              |     Y       |                                      |\r
+| subId                  | ID for the subscription you are |     Path         |   String   |              |     Y       |                                      |\r
 |                        | updating                        |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | delivery               | Address and credentials for     |     Body         |   Object   |              |     Y       |                                      |\r
 |                        | updating                        |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | delivery               | Address and credentials for     |     Body         |   Object   |              |     Y       |                                      |\r
@@ -615,16 +609,14 @@ Sample Body
 \r
  {\r
     "delivery" :{\r
 \r
  {\r
     "delivery" :{\r
-        "url" : "http://172.18.0.3:7070/",\r
-        "user" : "LOGIN",\r
-        "password" : "PASSWORD",\r
+        "url" : "http://192.0.0.1:7070/",\r
+        "user" : "NEW_LOGIN",\r
+        "password" : "NEW_PASSWORD",\r
         "use100" : true\r
     },\r
     "metadataOnly" : false,\r
         "use100" : true\r
     },\r
     "metadataOnly" : false,\r
-    "suspend" : false,\r
-    "groupid" : 29,\r
-    "subscriber" : "subscriber123"\r
-\r
+    "groupid" : 2,\r
+    "subscriber" : "subuser"\r
  }\r
 \r
 \r
  }\r
 \r
 \r
@@ -636,14 +628,14 @@ Get a Subscription
 Request URL\r
 ===========\r
 \r
 Request URL\r
 ===========\r
 \r
-http[s]://{host}:{port}/subscribe/{subId}\r
+http[s]://{host}:{port}/subs/{subId}\r
 \r
 * {subId}: Id of the subscription you want to see a representation of\r
 \r
 Sample Request\r
 ==============\r
 \r
 \r
 * {subId}: Id of the subscription you want to see a representation of\r
 \r
 Sample Request\r
 ==============\r
 \r
-``curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{subId}``\r
+``curl -k -H "X-ATT-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}``\r
 \r
 Response/Error Codes\r
 ====================\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -697,14 +689,14 @@ Delete a subscription
 Request URL\r
 ===========\r
 \r
 Request URL\r
 ===========\r
 \r
-http[s]://{host}:{port}/feed/{feedId}\r
+http[s]://{host}:{port}/subs/{subId}\r
 \r
 \r
-* {feedId}: Id of the subscription you want to delete\r
+* {subId}: Id of the subscription you want to delete\r
 \r
 Sample Request\r
 ==============\r
 \r
 \r
 Sample Request\r
 ==============\r
 \r
-``curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{feedId}``\r
+``curl -k -X DELETE -H "X-ATT-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}``\r
 \r
 Response/Error Codes\r
 ====================\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -753,16 +745,20 @@ Response/Error Codes
 Publish to Feed\r
 ---------------\r
 \r
 Publish to Feed\r
 ---------------\r
 \r
-**Description**: Publish a file to a created feed so that it can be shared to any subscribers of that feed\r
+**Description**: Publish data to a given feed\r
 \r
 Request URL\r
 ===========\r
 \r
 http[s]://{host}:{port}/publish/{feedId}/{fileName}\r
 \r
 \r
 Request URL\r
 ===========\r
 \r
 http[s]://{host}:{port}/publish/{feedId}/{fileName}\r
 \r
-* {feedId} is the id of the feed you are publishing to.\r
-* {fileId} is the id of the file you are publishing onto the feed.\r
+* {feedId} The id of the feed you are publishing to.\r
+* {fileId} The name of the file you are publishing to the feed.\r
 \r
 \r
+Sample Request\r
+==============\r
+\r
+``curl -k -X PUT --user {user}:{password} -H "Content-Type:application/octet-stream"  -H "X-ATT-DR-META:{\"filetype\":\"txt\"}" --data-binary @sampleFile.txt --post301 --location-trusted https://{host}:{port}/publish/{feedId}/sampleFile``\r
 \r
 Request parameters\r
 ==================\r
 \r
 Request parameters\r
 ==================\r
@@ -817,10 +813,6 @@ Response/Error Codes
 |                        | available                       |\r
 +------------------------+---------------------------------+\r
 \r
 |                        | available                       |\r
 +------------------------+---------------------------------+\r
 \r
-Sample Request\r
-==============\r
-\r
-``curl -v -X PUT --user {user}:{password} -H "Content-Type: application/octet-stream"  -H X-ATT-DR-META:'{"filetype":"zip"}' --data-binary @/opt/app/datartr/sampleFile.txt --post301 --location-trusted -k https://{host}:{port}/publish/{feedId}/sampleFile.txt``\r
 \r
 Delete a Published file\r
 -----------------------\r
 \r
 Delete a Published file\r
 -----------------------\r
@@ -838,7 +830,7 @@ http[s]://{host}:{port}/publish/{feedId}/{fileId}
 Sample Request\r
 ==============\r
 \r
 Sample Request\r
 ==============\r
 \r
-``curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/publish/{feedId}/{fileId}``\r
+``curl -k -X DELETE --user {user}:{password} --location-trusted https://{host}:{port}/publish/{feedId}/{fileId}``\r
 \r
 Response/Error Codes\r
 ====================\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -877,11 +869,16 @@ Feed logging
 Request URL\r
 ===========\r
 \r
 Request URL\r
 ===========\r
 \r
-\r
 http[s]://{host}:{port}/feedlog/{feedId}?{queryParameter}\r
 \r
 http[s]://{host}:{port}/feedlog/{feedId}?{queryParameter}\r
 \r
-* {feedId} : The id of the feed you want to get logs from\r
-* {queryParameter}: A parameter passed through to narrow the returned logs. multiple parameters can be passed\r
+* {feedId} : The id of the feed you want to get logs for\r
+* {queryParameter}: A parameter passed through to narrow the returned logs. Multiple parameters can be passed.\r
+\r
+\r
+Sample Request\r
+==============\r
+\r
+``curl -k https://{host}:{port}/feedlog/{feedId}?statusCode=204``\r
 \r
 Request parameters\r
 ==================\r
 \r
 Request parameters\r
 ==================\r
@@ -890,7 +887,7 @@ Request parameters
 | Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                |\r
 +========================+=================================+==================+============+==============+=============+======================================+\r
 | feedId                 | Id of the feed you want         |     Path         |   String   |              |     N       | 1                                    |\r
 | Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                |\r
 +========================+=================================+==================+============+==============+=============+======================================+\r
 | feedId                 | Id of the feed you want         |     Path         |   String   |              |     N       | 1                                    |\r
-|                        | logs from                       |                  |            |              |             |                                      |\r
+|                        | logs for                        |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | type                   | Select records of the           |     Path         |   String   |              |     N       | * pub: Publish attempt               |\r
 |                        | specified type                  |                  |            |              |             | * del: Delivery attempt              |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | type                   | Select records of the           |     Path         |   String   |              |     N       | * pub: Publish attempt               |\r
 |                        | specified type                  |                  |            |              |             | * del: Delivery attempt              |\r
@@ -1014,12 +1011,8 @@ Response/Error Codes
 |                        | is currently unavailable                  |\r
 +------------------------+-------------------------------------------+\r
 \r
 |                        | is currently unavailable                  |\r
 +------------------------+-------------------------------------------+\r
 \r
-Sample Request\r
-==============\r
 \r
 \r
-``curl -v -k https://{host}:{port}/feedlog/{feedId}?statusCode=204``\r
-\r
-Subscriber logging\r
+Subscription logging\r
 ------------------\r
 \r
 **Description**: View logging information for specified subscriptions, which can be narrowed down with further parameters\r
 ------------------\r
 \r
 **Description**: View logging information for specified subscriptions, which can be narrowed down with further parameters\r
@@ -1027,11 +1020,16 @@ Subscriber logging
 Request URL\r
 ===========\r
 \r
 Request URL\r
 ===========\r
 \r
-\r
 http[s]://{host}:{port}/sublog/{subId}?{queryParameter}\r
 \r
 * {subId}: The id of the feed you want to get logs from\r
 http[s]://{host}:{port}/sublog/{subId}?{queryParameter}\r
 \r
 * {subId}: The id of the feed you want to get logs from\r
-* {queryParameter}: A parameter passed through to narrow the returned logs. multiple parameters can be passed\r
+* {queryParameter}: A parameter passed through to narrow the returned logs. Multiple parameters can be passed.\r
+\r
+\r
+Sample Request\r
+==============\r
+\r
+``curl -k https://{host}:{port}/sublog/{subId}?statusCode=204``\r
 \r
 Request parameters\r
 ==================\r
 \r
 Request parameters\r
 ==================\r
@@ -1039,8 +1037,8 @@ Request parameters
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                |\r
 +========================+=================================+==================+============+==============+=============+======================================+\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                |\r
 +========================+=================================+==================+============+==============+=============+======================================+\r
-| subId                  | Id of the feed you want         |     Path         |   String   |              |     N       | 1                                    |\r
-|                        | logs from                       |                  |            |              |             |                                      |\r
+| subId                  | Id of the subscription you want |     Path         |   String   |              |     N       | 1                                    |\r
+|                        | logs for                        |                  |            |              |             |                                      |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | type                   | Select records of the           |     Path         |   String   |              |     N       | * pub: Publish attempt               |\r
 |                        | specified type                  |                  |            |              |             | * del: Delivery attempt              |\r
 +------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 | type                   | Select records of the           |     Path         |   String   |              |     N       | * pub: Publish attempt               |\r
 |                        | specified type                  |                  |            |              |             | * del: Delivery attempt              |\r
@@ -1087,7 +1085,7 @@ Response Parameters
 +------------------------+-------------------------------------------+\r
 | publishId              | The unique identifier assigned by the DR  |\r
 |                        | at the time of the initial publication    |\r
 +------------------------+-------------------------------------------+\r
 | publishId              | The unique identifier assigned by the DR  |\r
 |                        | at the time of the initial publication    |\r
-|                        | request (carried in the X-ATT-DRPUBLISH-ID|\r
+|                        | request(carried in the X-ATT-DR-PUBLISH-ID|\r
 |                        | header in the response to the original    |\r
 |                        | publish request) to a feed log URL or     |\r
 |                        | subscription log URL known to the system  |\r
 |                        | header in the response to the original    |\r
 |                        | publish request) to a feed log URL or     |\r
 |                        | subscription log URL known to the system  |\r
@@ -1165,8 +1163,3 @@ Response/Error Codes
 | 503                    | Service Unavailable - The DR API service  |\r
 |                        | is currently unavailable                  |\r
 +------------------------+-------------------------------------------+\r
 | 503                    | Service Unavailable - The DR API service  |\r
 |                        | is currently unavailable                  |\r
 +------------------------+-------------------------------------------+\r
-\r
-Sample Request\r
-==============\r
-\r
-``curl -v -k https://{host}:{port}/sublog/{subscriberId}?statusCode=204``\r