Documentation fixes

Change-Id: Ia8f0abc90b031b7769ef229302658fd0a1b79491
Signed-off-by: Emmett Cox <emmett.cox@ericsson.com>
Issue-ID: DMAAP-881

diff --git a/docs/data-router/data-router.rst b/docs/data-router/data-router.rst
index aaee385..39d61e1 100755 (executable)
--- a/docs/data-router/data-router.rst
+++ b/docs/data-router/data-router.rst
@@ -54,36 +54,36 @@ Create a Feed
 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 -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
 \r
 Request Parameters:\r
 ===================\r
 \r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Format             |  Valid/Example Values                |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| name                   | Feed name                       |     Body         |   String   |    <=20      |     Y       |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| version                | Feed version                    |     Body         |   String   |    <=20      |     Y       |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| description            | Feed description                |     Body         |   String   |              |     Y       |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| business description   | Business description            |     Body         |   String   |              |     Y       |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Authorization          | Information for authorizing     |     Body         |   Object   |              |     Y       |                     |                                      |\r
-|                        | publishing requests             |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| suspend                | Set to true if the feed is in   |     Body         |   Boolean  |              |     N       |                     | * true                               |\r
-|                        | the suspended state             |                  |            |              |             |                     | * false                              |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| group-id               |                                 |     Body         |   Integer  |              |     Y       |                     |                                      |\r
-|                        |                                 |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type           | To specify type of message      |     Header       |   String   |     20       |     N       |                     | 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   |     1        |     N       |                     |  username                            |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                |\r
++========================+=================================+==================+============+==============+=============+======================================+\r
+| name                   | Feed name                       |     Body         |   String   |    <=20      |     Y       |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| version                | Feed version                    |     Body         |   String   |    <=20      |     Y       |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| description            | Feed description                |     Body         |   String   |    <=256     |     Y       |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| business description   | Business description            |     Body         |   String   |    <=256     |     Y       |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Authorization          | Information for authorizing     |     Body         |   Object   |              |     Y       |                                      |\r
+|                        | publishing requests             |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| suspend                | Set to true if the feed is in   |     Body         |   Boolean  |              |     N       | * true                               |\r
+|                        | the suspended state             |                  |            |              |             | * false                              |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| group-id               |                                 |     Body         |   Integer  |              |     Y       |                                      |\r
+|                        |                                 |                  |            |              |             |                                      |\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -161,7 +161,7 @@ Sample Body
           ]\r
      },\r
 \r
-}\r
+ }\r
 \r
 Updating a Feed\r
 ---------------\r
@@ -171,32 +171,32 @@ Updating a Feed
 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 -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
 \r
 Request Parameters:\r
 ===================\r
 \r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Format             |  Valid/Example Values                |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| description            | Feed description                |     Body         |   String   |              |     Y       |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| business description   | Business description            |     Body         |   String   |              |     Y       |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Authorization          | Information for authorizing     |     Body         |   Object   |              |     Y       |                     |                                      |\r
-|                        | publishing requests             |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| suspend                | Set to true if the feed is in   |     Body         |   Boolean  |              |     N       |                     | * true                               |\r
-|                        | the suspended state             |                  |            |              |             |                     | * false                              |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| group-id               |                                 |     Body         |   Integer  |              |     Y       |                     |                                      |\r
-|                        |                                 |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type           | To specify type of message      |     Header       |   String   |     20       |     N       |                     | 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   |     1        |     N       |                     |  username                            |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                |\r
++========================+=================================+==================+============+==============+=============+======================================+\r
+| description            | Feed description                |     Body         |   String   |     <=256    |     Y       |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| business description   | Business description            |     Body         |   String   |     <=256    |     Y       |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Authorization          | Information for authorizing     |     Body         |   Object   |              |     Y       |                                      |\r
+|                        | publishing requests             |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| suspend                | Set to true if the feed is in   |     Body         |   Boolean  |              |     N       | * true                               |\r
+|                        | the suspended state             |                  |            |              |             | * false                              |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| group-id               |                                 |     Body         |   Integer  |              |     Y       |                                      |\r
+|                        |                                 |                  |            |              |             |                                      |\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -274,7 +274,7 @@ Sample Body
           ]\r
      },\r
 \r
-}\r
+ }\r
 \r
 Get a Feed\r
 ----------\r
@@ -291,7 +291,7 @@ http[s]://{host}:{port}/feed/{feedId}
 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 -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}``\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -352,7 +352,7 @@ http[s]://{host}:{port}/feed/{feedId}
 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 -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}``\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -412,37 +412,37 @@ http[s]://{host}:{port}/subscribe/{feedId}
 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 -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
 \r
 Request Parameters:\r
 ===================\r
 \r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Format             |  Valid/Example Values                |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| feedId                 | ID for the feed you are         |     Path         |   String   |              |     Y       |                     |                                      |\r
-|                        | subscribing to                  |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| delivery               | Address and credentials for     |     Body         |   Object   |              |     Y       |                     |                                      |\r
-|                        | delivery                        |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| follow_redirect        | Set to true if feed redirection |     Body         |   Boolean  |              |     Y       |                     | * true                               |\r
-|                        | is expected                     |                  |            |              |             |                     | * false                              |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| metadata_only          | Set to true if subscription is  |     Body         |   Boolean  |              |     Y       |                     | * true                               |\r
-|                        | to receive per-file metadata    |                  |            |              |             |                     | * false                              |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| suspend                | Set to true if the subscription |     Body         |   Boolean  |              |     N       |                     | * true                               |\r
-|                        | is in the suspended state       |                  |            |              |             |                     | * false                              |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| group-id               |                                 |     Body         |   Integer  |              |     Y       |                     |                                      |\r
-|                        |                                 |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type           | To specify type of message      |     Header       |   String   |     20       |     N       |                     | application/vnd.att-dr.subscription  |\r
-|                        | (feed,subscriber,publisher)     |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF  | User id of subscriber           |     Header       |   String   |     1        |     N       |                     |  username                            |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                |\r
++========================+=================================+==================+============+==============+=============+======================================+\r
+| feedId                 | ID for the feed you are         |     Path         |   String   |              |     Y       |                                      |\r
+|                        | subscribing to                  |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| delivery               | Address and credentials for     |     Body         |   Object   |              |     Y       |                                      |\r
+|                        | delivery                        |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| follow_redirect        | Set to true if feed redirection |     Body         |   Boolean  |              |     Y       | * true                               |\r
+|                        | is expected                     |                  |            |              |             | * false                              |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| metadata_only          | Set to true if subscription is  |     Body         |   Boolean  |              |     Y       | * true                               |\r
+|                        | to receive per-file metadata    |                  |            |              |             | * false                              |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| suspend                | Set to true if the subscription |     Body         |   Boolean  |              |     N       | * true                               |\r
+|                        | is in the suspended state       |                  |            |              |             | * false                              |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| group-id               |                                 |     Body         |   Integer  |              |     Y       |                                      |\r
+|                        |                                 |                  |            |              |             |                                      |\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -511,7 +511,7 @@ Sample Body
     "groupid" : 29,\r
     "subscriber" : "subscriber123"\r
 \r
-}\r
+ }\r
 \r
 Update subscription\r
 -------------------\r
@@ -526,37 +526,37 @@ http[s]://{host}:{port}/subscribe/{feedId}
 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 -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
 \r
 Request Parameters:\r
 ===================\r
 \r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Format             |  Valid/Example Values                |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| feedId                 | ID for the subscription you are |     Path         |   String   |              |     Y       |                     |                                      |\r
-|                        | updating                        |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| delivery               | Address and credentials for     |     Body         |   Object   |              |     Y       |                     |                                      |\r
-|                        | delivery                        |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| follow_redirect        | Set to true if feed redirection |     Body         |   Boolean  |              |     Y       |                     | * true                               |\r
-|                        | is expected                     |                  |            |              |             |                     | * false                              |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| metadata_only          | Set to true if subscription is  |     Body         |   Boolean  |              |     Y       |                     | * true                               |\r
-|                        | to receive per-file metadata    |                  |            |              |             |                     | * false                              |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| suspend                | Set to true if the subscription |     Body         |   Boolean  |              |     N       |                     | * true                               |\r
-|                        | is in the suspended state       |                  |            |              |             |                     | * false                              |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| group-id               |                                 |     Body         |   Integer  |              |     Y       |                     |                                      |\r
-|                        |                                 |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type           | To specify type of message      |     Header       |   String   |     20       |     N       |                     | application/vnd.att-dr.subscription  |\r
-|                        | (feed,subscriber,publisher)     |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF  | User id of subscriber           |     Header       |   String   |     1        |     N       |                     |  username                            |\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
+|                        | updating                        |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| delivery               | Address and credentials for     |     Body         |   Object   |              |     Y       |                                      |\r
+|                        | delivery                        |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| follow_redirect        | Set to true if feed redirection |     Body         |   Boolean  |              |     Y       | * true                               |\r
+|                        | is expected                     |                  |            |              |             | * false                              |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| metadata_only          | Set to true if subscription is  |     Body         |   Boolean  |              |     Y       | * true                               |\r
+|                        | to receive per-file metadata    |                  |            |              |             | * false                              |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| suspend                | Set to true if the subscription |     Body         |   Boolean  |              |     N       | * true                               |\r
+|                        | is in the suspended state       |                  |            |              |             | * false                              |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| group-id               |                                 |     Body         |   Integer  |              |     Y       |                                      |\r
+|                        |                                 |                  |            |              |             |                                      |\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -625,7 +625,7 @@ Sample Body
     "groupid" : 29,\r
     "subscriber" : "subscriber123"\r
 \r
-}\r
+ }\r
 \r
 \r
 Get a Subscription\r
@@ -643,7 +643,7 @@ http[s]://{host}:{port}/subscribe/{subId}
 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 -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{subId}``\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -704,7 +704,7 @@ http[s]://{host}:{port}/feed/{feedId}
 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 -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{feedId}``\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -767,18 +767,26 @@ http[s]://{host}:{port}/publish/{feedId}/{fileName}
 Request parameters\r
 ==================\r
 \r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Format             |  Valid/Example Values                |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| feedId                 | ID of the feed you are          |     Path         |   String   |              |     Y       |                     |                                      |\r
-|                        | publishing to                   |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| fileId                 | Name of the file when it  is    |     Path         |   String   |              |     Y       |                     |                                      |\r
-|                        | published to subscribers        |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type           | To specify type of message      |     Header       |   String   |     20       |     N       |                     | application/octet-stream             |\r
-|                        | format                          |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+\r
+| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Valid/Example Values                                                    |\r
++========================+=================================+==================+============+==============+=============+==========================================================================+\r
+| feedId                 | ID of the feed you are          |     Path         |   String   |              |     Y       |                                                                          |\r
+|                        | publishing to                   |                  |            |              |             |                                                                          |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+\r
+| fileId                 | Name of the file when it  is    |     Path         |   String   |              |     Y       |                                                                          |\r
+|                        | published to subscribers        |                  |            |              |             |                                                                          |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+\r
+| content-type           | To specify type of message      |     Header       |   String   |              |     Y       | application/octet-stream                                                 |\r
+|                        | format                          |                  |            |              |             |                                                                          |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+\r
+| X-ATT-DR-META          | Metadata for the file. Accepts  |     Header       |   String   |     4096     |     N       | '{"compressionType":"gzip","id": 1234, "transferred":true, "size":null}' |\r
+|                        | only non nested json objects    |                  |            |              |             |                                                                          |\r
+|                        | of the following type :         |                  |            |              |             |                                                                          |\r
+|                        | -Numbers                        |                  |            |              |             |                                                                          |\r
+|                        | -Strings                        |                  |            |              |             |                                                                          |\r
+|                        | -Lowercase boolean              |                  |            |              |             |                                                                          |\r
+|                        | -null                           |                  |            |              |             |                                                                          |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -812,7 +820,7 @@ Response/Error Codes
 Sample Request\r
 ==============\r
 \r
-curl -v -X PUT --user {user}:{password} -H "Content-Type: application/octet-stream" --data-binary @/opt/app/datartr/sampleFile.txt --post301 --location-trusted -k https://{host}:{port}/publish/{feedId}/sampleFile.txt\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
@@ -830,7 +838,7 @@ http[s]://{host}:{port}/publish/{feedId}/{fileId}
 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 -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/publish/{feedId}/{fileId}``\r
 \r
 Response/Error Codes\r
 ====================\r
@@ -878,37 +886,37 @@ http[s]://{host}:{port}/feedlog/{feedId}?{queryParameter}
 Request parameters\r
 ==================\r
 \r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Format             |  Valid/Example Values                |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| feedId                 | Id of the feed you want         |     Path         |   String   |              |     N       |                     | 1                                    |\r
-|                        | logs from                       |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| type                   | Select records of the           |     Path         |   String   |              |     N       |                     | * pub: Publish attempt               |\r
-|                        | specified type                  |                  |            |              |             |                     | * del: Delivery attempt              |\r
-|                        |                                 |                  |            |              |             |                     | * exp: Delivery expiry               |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| publishId              | Select records with specified   |     Path         |   String   |              |     N       |                     |                                      |\r
-|                        | publish id, carried in the      |                  |            |              |             |                     |                                      |\r
-|                        | X-ATT-DR-PUBLISH-ID header from |                  |            |              |             |                     |                                      |\r
-|                        | original publish request        |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| start                  | Select records created at or    |     Path         |   String   |              |     N       |                     | A date-time expressed in the format  |\r
-|                        | after specified date            |                  |            |              |             |                     | specified by RFC 3339                |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| end                    | Select records created at or    |     Path         |   String   |              |     N       |                     | A date-time expressed in the format  |\r
-|                        | before specified date           |                  |            |              |             |                     | specified by RFC 3339                |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| statusCode             | Select records with the         |     Path         |   String   |              |     N       |                     | An HTTP Integer status code or one   |\r
-|                        | specified statusCode field      |                  |            |              |             |                     | of the following special values:     |\r
-|                        |                                 |                  |            |              |             |                     |                                      |\r
-|                        |                                 |                  |            |              |             |                     | * Success: Any code between 200-299  |\r
-|                        |                                 |                  |            |              |             |                     | * Redirect: Any code between 300-399 |\r
-|                        |                                 |                  |            |              |             |                     | * Failure: Any code > 399            |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| expiryReason           | Select records with the         |     Path         |   String   |              |     N       |                     |                                      |\r
-|                        | specified expiry reason         |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| type                   | Select records of the           |     Path         |   String   |              |     N       | * pub: Publish attempt               |\r
+|                        | specified type                  |                  |            |              |             | * del: Delivery attempt              |\r
+|                        |                                 |                  |            |              |             | * exp: Delivery expiry               |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| publishId              | Select records with specified   |     Path         |   String   |              |     N       |                                      |\r
+|                        | publish id, carried in the      |                  |            |              |             |                                      |\r
+|                        | X-ATT-DR-PUBLISH-ID header from |                  |            |              |             |                                      |\r
+|                        | original publish request        |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| start                  | Select records created at or    |     Path         |   String   |              |     N       | A date-time expressed in the format  |\r
+|                        | after specified date            |                  |            |              |             | specified by RFC 3339                |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| end                    | Select records created at or    |     Path         |   String   |              |     N       | A date-time expressed in the format  |\r
+|                        | before specified date           |                  |            |              |             | specified by RFC 3339                |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| statusCode             | Select records with the         |     Path         |   String   |              |     N       | An HTTP Integer status code or one   |\r
+|                        | specified statusCode field      |                  |            |              |             | of the following special values:     |\r
+|                        |                                 |                  |            |              |             |                                      |\r
+|                        |                                 |                  |            |              |             | * Success: Any code between 200-299  |\r
+|                        |                                 |                  |            |              |             | * Redirect: Any code between 300-399 |\r
+|                        |                                 |                  |            |              |             | * Failure: Any code > 399            |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| expiryReason           | Select records with the         |     Path         |   String   |              |     N       |                                      |\r
+|                        | specified expiry reason         |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response Parameters\r
 ===================\r
@@ -1009,7 +1017,7 @@ Response/Error Codes
 Sample Request\r
 ==============\r
 \r
-curl -v -k https://{host}:{port}/feedlog/{feedId}?statusCode=204\r
+``curl -v -k https://{host}:{port}/feedlog/{feedId}?statusCode=204``\r
 \r
 Subscriber logging\r
 ------------------\r
@@ -1028,38 +1036,38 @@ http[s]://{host}:{port}/sublog/{subId}?{queryParameter}
 Request parameters\r
 ==================\r
 \r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name                   | Description                     |  Param Type      |  Data Type |   MaxLen     |  Required   |  Format             |  Valid/Example Values                |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| subId                  | Id of the feed you want         |     Path         |   String   |              |     N       |                     | 1                                    |\r
-|                        | logs from                       |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| type                   | Select records of the           |     Path         |   String   |              |     N       |                     | * pub: Publish attempt               |\r
-|                        | specified type                  |                  |            |              |             |                     | * del: Delivery attempt              |\r
-|                        |                                 |                  |            |              |             |                     | * exp: Delivery expiry               |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| publishId              | Select records with specified   |     Path         |   String   |              |     N       |                     |                                      |\r
-|                        | publish id, carried in the      |                  |            |              |             |                     |                                      |\r
-|                        | X-ATT-DR-PUBLISH-ID header from |                  |            |              |             |                     |                                      |\r
-|                        | original publish request        |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| start                  | Select records created at or    |     Path         |   String   |              |     N       |                     | A date-time expressed in the format  |\r
-|                        | after specified date            |                  |            |              |             |                     | specified by RFC 3339                |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| end                    | Select records created at or    |     Path         |   String   |              |     N       |                     | A date-time expressed in the format  |\r
-|                        | before specified date           |                  |            |              |             |                     | specified by RFC 3339                |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| statusCode             | Select records with the         |     Path         |   String   |              |     N       |                     | An Http Integer status code or one   |\r
-|                        | specified statusCode field      |                  |            |              |             |                     | of the following special values:     |\r
-|                        |                                 |                  |            |              |             |                     |                                      |\r
-|                        |                                 |                  |            |              |             |                     | * Success: Any code between 200-299  |\r
-|                        |                                 |                  |            |              |             |                     | * Sedirect: Any code between 300-399 |\r
-|                        |                                 |                  |            |              |             |                     | * Sailure: Any code > 399            |\r
-|                        |                                 |                  |            |              |             |                     |                                      |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| expiryReason           | Select records with the         |     Path         |   String   |              |     N       |                     |                                      |\r
-|                        | specified expiry reason         |                  |            |              |             |                     |                                      |\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| type                   | Select records of the           |     Path         |   String   |              |     N       | * pub: Publish attempt               |\r
+|                        | specified type                  |                  |            |              |             | * del: Delivery attempt              |\r
+|                        |                                 |                  |            |              |             | * exp: Delivery expiry               |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| publishId              | Select records with specified   |     Path         |   String   |              |     N       |                                      |\r
+|                        | publish id, carried in the      |                  |            |              |             |                                      |\r
+|                        | X-ATT-DR-PUBLISH-ID header from |                  |            |              |             |                                      |\r
+|                        | original publish request        |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| start                  | Select records created at or    |     Path         |   String   |              |     N       | A date-time expressed in the format  |\r
+|                        | after specified date            |                  |            |              |             | specified by RFC 3339                |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| end                    | Select records created at or    |     Path         |   String   |              |     N       | A date-time expressed in the format  |\r
+|                        | before specified date           |                  |            |              |             | specified by RFC 3339                |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| statusCode             | Select records with the         |     Path         |   String   |              |     N       | An Http Integer status code or one   |\r
+|                        | specified statusCode field      |                  |            |              |             | of the following special values:     |\r
+|                        |                                 |                  |            |              |             |                                      |\r
+|                        |                                 |                  |            |              |             | * Success: Any code between 200-299  |\r
+|                        |                                 |                  |            |              |             | * Redirect: Any code between 300-399 |\r
+|                        |                                 |                  |            |              |             | * Failure: Any code > 399            |\r
+|                        |                                 |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| expiryReason           | Select records with the         |     Path         |   String   |              |     N       |                                      |\r
+|                        | specified expiry reason         |                  |            |              |             |                                      |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
 \r
 Response Parameters\r
 ===================\r
@@ -1161,4 +1169,4 @@ Response/Error Codes
 Sample Request\r
 ==============\r
 \r
-curl -v -k https://{host}:{port}/sublog/{subscriberId}?statusCode=204
\ No newline at end of file
+``curl -v -k https://{host}:{port}/sublog/{subscriberId}?statusCode=204``\r

diff --git a/docs/data-router/logging.rst b/docs/data-router/logging.rst
index ac6aa95..6ac7a0a 100644 (file)
--- a/docs/data-router/logging.rst
+++ b/docs/data-router/logging.rst
@@ -15,11 +15,19 @@ Currently Data Router does not have any unique error codes. However the followin
 could possibly occur in Data Router:
 
     OK = 200 : The normal response from a successful update or get of a feed or subscription
+
     CREATED = 201 : the normal response from successfully creating or subscribing to a feed.
+
     NO_CONTENT = 204 : the normal response from a successful publish attempt and on successfully deleting a feed or subscription
+
     MOVED_PERMANENTLY = 301 :the normal redirect response from prov to a publisher
+
     BAD_REQUEST = 400: Usually indicates that either Json object in request body is incorrect in some way, or an Invalid parameter value was included in query string.
+
     UNAUTHORIZED = 401 : Usually indicated either request was missing Authorization header, or indicates incorrect Username/password credentials
+
     FORBIDDEN = 403 : Usually indicates the request originated from an unauthorized IP address, or that a client certificate was not a part of authorized list.
+
     NOT_FOUND = 404 : Usually indicates an incorrect URI
+
     METHOD_NOT_ALLOWED = 405 : Indicates an HTTP method is not accepted for given URI
\ No newline at end of file