correct documentation rst file errors and warnings

DMAAP-165
Signed-off-by: rn509j <rn509j@att.com>
Change-Id: I57a1aae5782c47325c108804c2390e8b85ebec3f

diff --git a/docs/Installation/Installation.rst b/docs/Installation/Installation.rst
index 3723a19..17636ff 100644 (file)
--- a/docs/Installation/Installation.rst
+++ b/docs/Installation/Installation.rst
@@ -24,8 +24,10 @@ kafka runs on 172.18.0.2 and dmaap on 172.18.0.4.
 4) Install docker and docker-compose\r
 \r
 5) Go to messageservice/src/main/resources/docker-compose and run:\r
-\r
-   docker-compose up \96d\r
+   \r
+   .. code:: bash\r
+   \r
+               docker-compose up \96d\r
 \r
    This should start 3 containers.\r
 \r

diff --git a/docs/message-router/message-router.rst b/docs/message-router/message-router.rst
index b58e258..d441477 100644 (file)
--- a/docs/message-router/message-router.rst
+++ b/docs/message-router/message-router.rst
@@ -58,16 +58,15 @@ are not inspected for content.
 | Content-Type            |  Description                                                                                                    |\r
 +=========================+=================================================================================================================+\r
 | text/plain              | Each line in the POST body is treated as a separate message. No partition key is specified, and therefore no    |\r
-|                            | order is guaranteed. This format is mainly for test, as messages are highly likely to be re-ordered when        |\r
-|                            | delivered through the Kafka cluster.                                                                            |\r
+|                         |    order is guaranteed. This format is mainly for test, as messages are highly likely to be re-ordered when        |\r
+|                         | delivered through the Kafka cluster.                                                                            |\r
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+\r
 | application/json        | The payload maybe a single JSON object or a JSON array of JSON objects. Each object is handled as an individual |\r
-|                                                | message..Note that use of this format may result in equivalent but altered JSON objects sent to consumers.      | \r
-|                                                | That's because MR uses a standard JSON parser to read each object into memory before pushing the object to the  |\r
-|                                                | Kafka system. At that point, the JSON object is re-written from the in-memory object. This can result in        |\r
-|                                                | re-ordered fields or changes in whitespace. If you want to preseve JSON objects exactly,                        |\r
-|                                                | use application/cambria. Recommended to follow the JSON format after validating the                             |\r
-|                                                | message in https://jsonformatter.curiousconcept.com/                                                                                                            |\r
+|                         | message..Note that use of this format may result in equivalent but altered JSON objects sent to consumers.      | \r
+|                         | That's because MR uses a standard JSON parser to read each object into memory before pushing the object to the  |\r
+|                         | Kafka system. At that point, the JSON object is re-written from the in-memory object. This can result in        |\r
+|                         | re-ordered fields or changes in whitespace. If you want to preseve JSON objects exactly,                        |\r
+|                                                | use application/cambria. Recommended to follow the JSON format.                                                 |\r
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+\r
 \r
 Publishers\r
@@ -209,25 +208,24 @@ GET http(s)://{HOST:PORT}}/events/{topicname}/{consumegroup}/{consumerid}/{timeo
 Request Parameters:\r
 ===================\r
 \r
-+--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-| Name         | Description                     |  Param Type      |  data type |   MaxLen     |  Required   |  Format     |  Valid/Example Values    |\r
-+==============+=================================+==================+============+==============+=============+=============+==========================+\r
-| Topicname    | topic name to be posted         |     Path         |   String   |    40        |     Y       | namespace.  |                                             |\r
-|                         |                                                         |                              |            |              |             | String      |                          |\r
-+--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-| Consumer     | A name that uniquely identifies |     Path         |   String   |              |     Y       |             | CG1                      |\r
-| group                   | your subscribers                |                  |            |              |             |             |                          |\r
-+------------- +---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-| consumerId   | Within your subscribers group,  |     Path         |   String   |              |     Y       |             | C1                       |\r
-|                         | a name that uniquely identifies |                  |            |              |             |             |                          |\r
-|                         | your subscribers  process       |                  |            |              |             |             |                          | +--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-| content-type | To specify type of message      |     Header       |   String   |     20       |     N       |             | aplication/json          |\r
-|                         | content(json,text or cambria)   |                  |            |              |             |             |                          |\r
-+--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-| Username     | userid                          |     Header       |   String   |     1        |     N       |             |                          |\r
-+--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-| Password     |                                 |     Header       |   String   |     1        |     N       |             |                          |\r
-+--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+ \r
++--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
+| Name         | Description                     |  Param Type      |  data type |   MaxLen     |  Required   |  Format             |  Valid/Example Values  |\r
++==============+=================================+==================+============+==============+=============+=====================+========================+\r
+| Topicname    | topic name to be posted         |     Path         |   String   |    40        |     Y       | namespace.String    |                                           |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
+| Consumer     | A name that uniquely identifies |     Path         |   String   |              |     Y       |                     | CG1                    |\r
+| group        | your subscribers                |                  |            |              |             |                     |                        |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
+| consumerId   | Within your subscribers group,  |     Path         |   String   |              |     Y       |                     | C1                     |\r
+|              | a name that uniquely identifies |                  |            |              |             |                     |                        |\r
+|                         | your subscribers  process       |                  |            |              |             |                     |                        | +--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
+| content-type | To specify type of message      |     Header       |   String   |     20       |     N       |                     | aplication/json        |\r
+|                         | content(json,text or cambria)   |                  |            |              |             |                     |                        |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
+| Username     | userid                          |     Header       |   String   |     1        |     N       |                     |                        |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
+| Password     |                                 |     Header       |   String   |     1        |     N       |                     |                        |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+ \r
 \r
 **NOTE1**:Subscribers /user should have access on the topics. The user () and\r
 permissions details needs to be in AAF.\r
@@ -251,6 +249,11 @@ Response Parameters:
 | ResponseBody     | Messages consumed from topic   | Json       | Json         |                                                           |\r
 +------------------+--------------------------------+------------+--------------+-----------------------------------------------------------+\r
 \r
+\r
+Response /Error Codes\r
+=====================\r
+\r
+\r
 +---------------------------+------------------------------------+\r
 | Response statusCode       | Response statusMessage             |\r
 +===========================+====================================+\r
@@ -262,7 +265,7 @@ Response Parameters:
 +---------------------------+------------------------------------+\r
 \r
 +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
-| Error code              |  HTTP Code      |  Description               | Issue reason                                                                                |\r
+| Error code              |  HTTPCode       |  Description               | Issue Reason                                                                                |\r
 +=========================+=================+============================+=============================================================================================+\r
 | DMaaP\_MR\_ERR\_3008    | 413             | Request Entity too large   | Message size exceeds the batch limit <limit>.Reduce the batch size and try again            |\r
 +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
@@ -332,6 +335,7 @@ Request Parameters:
 | 500-599                   | the DMaaP service has a problem    |\r
 +---------------------------+------------------------------------+\r
 \r
+\r
 +-------------------------+-----------------+--------------------------------------------------+\r
 | Error code              |  HTTP Code      |  Description                                     |\r
 +=========================+=================+==================================================+\r
@@ -349,14 +353,14 @@ Response Parameters
 +==================+================================+============+==============+===========================================================+\r
 | httpStatusCode   |                                |            |              | 200, 201 etc.                                             |\r
 +------------------+--------------------------------+------------+--------------+-----------------------------------------------------------+\r
-| mrErrorCode      | Numeric error code             |            |              | 5005                                                       |\r
+| mrErrorCode      | Numeric error code             |            |              | 5005                                                      |\r
 +------------------+--------------------------------+------------+--------------+-----------------------------------------------------------+\r
 | errorMessage     |                                |            |              | SUCCESS, or error message.                                |\r
 +------------------+--------------------------------+------------+--------------+-----------------------------------------------------------+\r
 | helpURL          | helpurl                        |            |              |                                                           |\r
 +------------------+--------------------------------+------------+--------------+-----------------------------------------------------------+\r
-| ResponseBody     | Topic details (owner,          |            |              |                                                           |\r
-|                  | trxEnabled=true)               | Json       | Json         |                                                           |\r
+| ResponseBody     | Topic details (owner,          |  Json      |  Json        |                                                           |\r
+|                  | trxEnabled=true)               |            |              |                                                           |\r
 +------------------+--------------------------------+------------+--------------+-----------------------------------------------------------+\r
 \r
 \r