correct documentation rst file errors and warnings 27/19927/1
authorrn509j <rn509j@att.com>
Fri, 20 Oct 2017 19:21:59 +0000 (15:21 -0400)
committerrn509j <rn509j@att.com>
Fri, 20 Oct 2017 19:23:45 +0000 (15:23 -0400)
DMAAP-165
Signed-off-by: rn509j <rn509j@att.com>
Change-Id: I58bc1c2ae380219747f23fa800f2d5bcc8f3dcb5

docs/Filter/Filter.rst
docs/Installation/Installation.rst
docs/message-router/message-router.rst

index d6114bb..b792a43 100644 (file)
@@ -63,7 +63,7 @@ Types of Filters
 \r
 - **Assigned:**\r
   - Choose a field from the event to check for assignment. This filter\r
-    matches when the field is assigned.\r
+  matches when the field is assigned.\r
 \r
 +-------------------+--------------------------------------------------------+------------+-----------------+\r
 | **Field**         | **Description**                                        | **Type**   | **Notes**       |\r
@@ -98,6 +98,7 @@ Types of Filters
 +-------------+---------------------------------------------------+------------+--------------+\r
 \r
 -  **Equals:**\r
+\r
   - Choose a field from the event and a value to check for equality.\r
 \r
 +-------------+----------------------------------------------+------------+--------------+\r
@@ -109,6 +110,7 @@ Types of Filters
 +-------------+----------------------------------------------+------------+--------------+\r
 \r
 -  **FlatironObjectExists**\r
+\r
   -  Matches when the given object exists in the given Flatiron instance.\r
 \r
 +-------------+---------------------------------------------+------------+--------------+\r
@@ -121,7 +123,7 @@ Types of Filters
 \r
 - **IsAging**\r
   -  Choose a field to test. This filter matches if the expression is\r
-     numeric.\r
+  numeric.\r
 \r
 +-------------+---------------------------------------------+------------+--------------+\r
 | **Field**   | **Description**                             | **Type**   | **Notes**    |\r
@@ -139,7 +141,7 @@ Types of Filters
 | field       | The field to test. Supports ${} notation.   | STRING     | Any string   |\r
 +-------------+---------------------------------------------+------------+--------------+\r
 \r
--  **MathCondition**\r
+- **MathCondition**\r
   - Choose a field from the event and a value for logical math conditions.\r
 \r
 +-------------+-------------------------------------------------+------------+-----------------------------------+\r
@@ -165,7 +167,7 @@ Types of Filters
 | filter      | The filter to negate.   | FILTER     | A filter    |\r
 +-------------+-------------------------+------------+-------------+\r
 \r
--  **NotEqual**\r
+- **NotEqual**\r
   -  Choose a field from the event and a value to check for inequality.\r
 \r
 +-------------+----------------------------------------------+------------+--------------+\r
@@ -176,7 +178,7 @@ Types of Filters
 | value       | The value to match. Supports ${} notation.   | STRING     | Any string   |\r
 +-------------+----------------------------------------------+------------+--------------+\r
 \r
--  **NotOneOf**\r
+- **NotOneOf**\r
   -  Match when the specified field does not have a value from the given\r
      list.\r
 \r
@@ -188,7 +190,7 @@ Types of Filters
 | values      | The matching values.                        | LIST       | A list of strings   |\r
 +-------------+---------------------------------------------+------------+---------------------+\r
 \r
--  **OneOf**\r
+- **OneOf**\r
   -  Match when the specified field has a value from the given list.\r
 \r
 +-------------+---------------------------------------------+------------+---------------------+\r
@@ -246,9 +248,9 @@ Types of Filters
 \r
 - **WithinSecondsFrom**\r
   - This filter matches when the specified epoch time value is within the\r
-    given number of seconds from the baseline time value. Both time values\r
-    are assumed to be in seconds. If a value is in milliseconds, set\r
-    baselineTimeInMillis and/or eventTimeInMillis to true.\r
+  given number of seconds from the baseline time value. Both time values\r
+  are assumed to be in seconds. If a value is in milliseconds, set\r
+  baselineTimeInMillis and/or eventTimeInMillis to true.\r
 \r
 +------------------------+------------------------------------------------------------+------------+-----------------+\r
 | **Field**              | **Description**                                            | **Type**   | **Notes**       |\r
@@ -266,9 +268,9 @@ Types of Filters
 \r
 - **WithinTimeFromNow**\r
   - This filter matches when the named field has an epoch time value\r
-    within the given number of seconds from the current time. The event's\r
-    time value is assumed to be in seconds. If it's in milliseconds, set\r
-    eventTimeInMillis to true.\r
+  within the given number of seconds from the current time. The event's\r
+  time value is assumed to be in seconds. If it's in milliseconds, set\r
+  eventTimeInMillis to true.\r
 \r
 +---------------------+---------------------------------------------------------+------------+-----------------+\r
 | **Field**           | **Description**                                         | **Type**   | **Notes**       |\r
@@ -386,12 +388,12 @@ Types of Filters
     +-----------------------------------------+\r
 \r
    - This filter matches events in which the field "foo" has value "abc"\r
-     and the field "bar" is assigned to some value (as opposed to not being\r
-     present on the event).\r
+   and the field "bar" is assigned to some value (as opposed to not being\r
+   present on the event).\r
    -  Filters are used by the consumers to filter out data and consume only\r
-     specific set of data which matches the conditions mentioned in filter.\r
+   specific set of data which matches the conditions mentioned in filter.\r
    -  Filters can be passed as a query parameter by the consumer in consume\r
-     request as mentioned below:\r
+   request as mentioned below:\r
    - **http://localhost:8080/DMaaP/dmaaprest/events/DMaaP/consumergroup/mHOeNFY4XiWx4CBa?filter=\\{"class":"Equals",\r
      "field":"email", "value":"`test@abc.com <mailto:test@att.com>`__" }** \r
    - Filters can be applied only on data in JSON format i.e. if applied,\r
@@ -402,7 +404,7 @@ Types of Filters
    the GET request. This will filter the stream of messages sent back to\r
    the subscriber, but for this to work, there are some requirements: \r
 \r
-    -  The message payload must be JSON\r
+   -  The message payload must be JSON\r
 \r
    -  Only a filter built from Highland Park's Standard Library  may be\r
       used. (The Cambria API server doesn't have access to plugged in\r
index 3723a19..653de26 100644 (file)
@@ -25,7 +25,7 @@ kafka runs on 172.18.0.2 and dmaap on 172.18.0.4.
 \r
 5) Go to messageservice/src/main/resources/docker-compose and run:\r
 \r
-   docker-compose up \96d\r
+   docker-compose up\96d\r
 \r
    This should start 3 containers.\r
 \r
index 3b71851..b3b8c91 100644 (file)
@@ -92,20 +92,21 @@ POST http(s)://{HOST:PORT}/events/{topicname}
 Request Parameters\r
 ==================\r
 \r
-+--------------------------+---------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
-| Name                     | Description                     | Param Type       | Data type  | Max Len   | Required    | Format                         | Valid/EXample values        |\r
-+==========================+=================================+==================+============+===========+=============+================================+=============================+\r
-| Topicname                | topic name to be posted         | Path             | String     | 40        | Y           |  <app namespace>.<topicname>   | org.onap.crm.empdetails     |\r
-+--------------------------+---------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
-| content-type             | To specify type of message      | Header           | String     | 20        | N           |                                | application/json            |\r
-+--------------------------+---------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+| Username                 | userid                          | Header           | String     |           | N           | Basic Authentication Header    |                             |\r
-+--------------------------+---------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
-| Password                 | userid                          | Header           | String     |           | N           | Basic Authentication Header    |                             |\r
-+--------------------------+---------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
-| partitionKey             |                                 |  QueryParam      | String     |           | N           | String value                   |?Partitionkey=123            |\r
-+--------------------------+---------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
-\r
-**NOTE **: Publishers/user should have access on the topics. The user (id) and\r
++--------------------+------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
+| Name               | Description                  | Param Type       | Data type  | Max Len   | Required    | Format                         | Valid/EXample values        |\r
++====================+==============================+==================+============+===========+=============+================================+=============================+\r
+| Topicname          | topic name to be posted      | Path             | String     | 40        | Y           |  <app namespace>.<topicname>   | org.onap.crm.empdetails     |\r
++--------------------+------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
+| content-type       | To specify type of message   | Header           | String     | 20        | N           |                                | application/json            |\r
++--------------------+------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
+| Username           | userid                       | Header           | String     |           | N           | Basic Authentication Header    |                             |\r
++--------------------+------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
+| Password           |                              | Header           | String     |           | N           | Basic Authentication Header    |                             |\r
++--------------------+------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
+| partitionKey       |                              | QueryParam       | String     |           | N           | String value                   | ?Partitionkey=123           |\r
++--------------------+------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
+\r
+**NOTE**: Publishers/user should have access on the topics. The user (id) and\r
 permissions details needs to be in AAF.\r
 \r
 Response Parameters\r
@@ -159,7 +160,7 @@ Response /Error Codes
 +------------------------+---------------+---------------------------------+---------------------------------------------------------------------------------------------------------+\r
 \r
 Sample Request:\r
-==============\r
+===============\r
 \r
 +-----------------------------------------------------------------------------------+\r
 | POST                                                                              |\r
@@ -178,7 +179,7 @@ Sample Request:
 +-----------------------------------------------------------------------------------+\r
 \r
 Sample Response:\r
-===============\r
+================\r
 \r
 +---------------------------------------------------------------------+\r
 | HTTP/1.1 200 OK                                                     |\r
@@ -208,31 +209,31 @@ 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
-|Consumergroup| A name that uniquely identifies |     Path         |    String  |              |             |             |                                                 |\r
-|                        | your subscribers                |                  |            |              |      Y      |             |               CG1                               |\r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+\r
-| consumerId  | Within your subscribers group,  |                  |            |              |             |             |                                                 |\r
-|                        | a name that uniquely identifies |      Path        |   String   |              |       y     |             |              C1                                 |\r
-|                        | your subscribers  process       |                  |            |              |             |             |                                                 | +-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+\r
-| content-type| To specify type of message      |                  |            |              |             |             |aplication/json                                  |\r
-|                        | content(json,text or cambria)   |      Header      |   String   |         20   |      N      |             |                                                 |\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.  |                                             |\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
 **NOTE1**:Subscribers /user should have access on the topics. The user () and\r
 permissions details needs to be in AAF.\r
 \r
 Response Parameters:\r
-===================\r
+====================\r
 \r
 +------------------+--------------------------------+------------+--------------+-----------------------------------------------------------+\r
 | Name             | Description                    |  Type      | Format       | Valid/Example Values                                      |\r
@@ -260,24 +261,33 @@ Response Parameters:
 | 500-599                   | the DMaaP service has a problem    |\r
 +---------------------------+------------------------------------+\r
 \r
-+-------------------------+-----------------+----------------------------+----------------------------------------------------------------------------------------------------+\r
-| Error code              |  HTTP Code      |  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
-| DMaaP\_MR\_ERR\_3009    | 500             | Internal Server Error      | Unable to publish messages. Please contact administartor                                           | +-------------------------+-----------------+----------------------------+----------------------------------------------------------------------------------------------------+\r
-| DMaaP\_MR\_ERR\_3010    | 400             | Bad Request                | Incorrect Batching format. Please correct the batching format and try again                        | +-------------------------+-----------------+----------------------------+----------------------------------------------------------------------------------------------------+\r
-| DMaaP\_MR\_ERR\_3011    | 413             | Request Entity too large   | Message size exceeds the message size limit <limit>.Reduce the message size and try again          | +-------------------------+-----------------+----------------------------+----------------------------------------------------------------------------------------------------+\r
-\r
++-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+| Error code              |  HTTP Code      |  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
+| DMaaP\_MR\_ERR\_3009    | 500             | Internal Server Error      | Unable to publish messages. Please contact administartor                                    | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_3010    | 400             | Bad Request                | Incorrect Batching format. Please correct the batching format and try again                 | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_3011    | 413             | Request Entity too large   | Message size exceeds the message size limit <limit>.Reduce the message size and try again   | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_5012    | 429             | Too many requests          | This client is making too many requests. Please use a long poll setting to decrease the     | \r
+|                         |                 |                            | number of requests that result in empty responses.                                          |\r
++-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+|                         | 503             | Service Unavailable        | Service Unavailable                                                                         | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
 \r
 Sample Request:\r
-==============\r
+===============\r
 \r
 +----------------------------------------------------------------------------------------------------+\r
 | GET  http://<hostname>:3904/events/com.att.dmaap.mr.sprint/mygroup/mycus                           |\r
-|  Content-Type: application/json                                                                    |\r
+|                                                                                                    |\r
+| Content-Type: application/json                                                                     |\r
+|                                                                                                    |\r
 | Example:                                                                                           |\r
-|curl -u XXX@csp.abc.com:MRDmap2016$ -X GET -d 'MyfirstMessage'                                      | \r
+|                                                                                                    |\r
+|curl -u XXX@csp.abc.com:MRDmap2016$ -X GET -d 'MyfirstMessage'                                      |\r
+|                                                                                                    | \r
 |http://mrlocal00.dcae.proto.research.att.com:3904/events/com.att.ecomp_test.crm.preDeo/myG/C1       |\r
+|                                                                                                    |\r
 |[I am r sending first msg,I am R sending first msg]                                                 |\r
 +----------------------------------------------------------------------------------------------------+\r
 \r
@@ -293,25 +303,24 @@ Request URL:
 POST http(s)://{HOST:PORT}/topics/create\r
 \r
 Request Parameters:\r
-==================\r
+===================\r
 \r
-+----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+\r
-| Name           | Description                     |  Param Type      |  data type |   MaxLen     |  Req\92d      |  Format     |  Valid/Example Values             |\r
-+================+=================================+==================+============+==============+=============+=============+===================================+\r
-| Topicname      | topicname to be created in MR   |     Body         |   String   |        20    |     Y       | Json        |                com.att.dmaap.mr.metrics      |\r
-+----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+       \r
-|topicDescription|   description for topic         |      Body        |   String   |     15       |     Y       |             |                                   |\r
-+----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+  \r
-|partitionCount  |   Kafka topic partition         |     Body         |   String   |     1        | Y           |             |                                   |\r
-+----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
-|replicationCount|   Kafka topic replication       |     Body         |   String   |     1        | Y           |             |  3 (Default -for 3 node Kafka )   |\r
-+----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
-|transaction     |to create transaction id for     |     Body         | Boolean    |              |             |             |                                   |\r
-|                |     each message transaction       |                  |            |      1       |        N    |             |   true                            |\r
-| Enabled        |                                 |                  |            |              |             |             |                                   | \r
-+----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
-|Content-Type    |   application/json              |     Header       |   String   |              |             |             |  application/json                 |\r
-+----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+\r
++-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+\r
+| Name            | Description                     |  Param Type      |  datatype  |   MaxLen     |  Required   |  Format     |  Valid/Example Values             |\r
++=================+=================================+==================+============+==============+=============+=============+===================================+\r
+| Topicname       | topicname to be created in MR   |     Body         |   String   |        20    |     Y       | Json        |               com.att.dmaap.mr.metrics   |\r
++-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+       \r
+|topicDescription |   description for topic         |      Body        |   String   |     15       |     Y       |             |                                   |\r
++-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+  \r
+|partitionCount   |   Kafka topic partition         |     Body         |   String   |     1        |    Y        |             |                                   |\r
++-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
+|replicationCount |   Kafka topic replication       |     Body         |   String   |     1        |    Y        |             |  3 (Default -for 3 node Kafka )   |\r
++-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
+|transaction      |to create transaction id for     |     Body         | Boolean    |     1        |    N        |             |   true                            |\r
+| Enabled         |    each message transaction        |                  |            |              |             |             |                                   |\r
++-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
+|Content-Type     |   application/json              |     Header       |   String   |              |             |             |  application/json                 |\r
++-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+\r
 \r
 +---------------------------+------------------------------------+\r
 | Response statusCode       | Response statusMessage             |\r
@@ -328,9 +337,10 @@ Request Parameters:
 +=========================+=================+==================================================+\r
 | DMaaP\_MR\_ERR\_5001    | 500             | Failed to retrieve list of all topics            | +-------------------------+-----------------+--------------------------------------------------+\r
 | DMaaP\_MR\_ERR\_5002    | 500             | Failed to retrieve details of topic:<topicName>  |     +-------------------------+-----------------+--------------------------------------------------+\r
-| DMaaP\_MR\_ERR\_5003    | 500             |Failed to create topic:<topicName>                | +-------------------------+-----------------+--------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_5003    | 500             | Failed to create topic:<topicName>               | +-------------------------+-----------------+--------------------------------------------------+\r
 | DMaaP\_MR\_ERR\_5004    | 500             | Failed to delete topic:<topicName>               | +-------------------------+-----------------+--------------------------------------------------+\r
 \r
+\r
 Response Parameters\r
 ====================\r
 \r
@@ -351,28 +361,29 @@ Response Parameters
 \r
 \r
 Sample Request:\r
-==============\r
+===============\r
+\r
+    .. code:: bash\r
+       \r
+           POST   http://<hostname>:3904/topic/create \r
+               Request Body  \r
+               {"topicName":"com.abc.dmaap.mr.topicname","description":"This is a SAPTopic ",\r
+               "partitionCount":"1","replicationCount":"3","transactionEnabled":"true"}  \r
+               Content-Type: application/json \r
+               Example:\r
+               curl -u XXXc@csp.abc.com:xxxxx$  -H 'Content-Type:application/json' -X POST -d \r
+               @topicname.txt  http://mrlocal00.dcae.proto.research.abc.com:3904/topics/create\r
+               {  \r
+               "writerAcl": {   \r
+               "enabled": false, \r
+               "users": []  \r
+               }, \r
+               "description": "This is a TestTopic", \r
+               "name": "com.abc.ecomp_test.crm.Load9",   \r
+               "readerAcl": {  \r
+               "enabled": false,  \r
+               "users": [] \r
 \r
-+-----------------------------------------------------------------------------------+\r
-| POST   http://<hostname>:3904/topic/create                                        |\r
-|Request Body                                                                       |\r
-|{"topicName":"com.abc.dmaap.mr.topicname","description":"This is a SAPTopic ",     |\r
-| "partitionCount":"1","replicationCount":"3","transactionEnabled":"true"}          |\r
-| Content-Type: application/json                                                    |\r
-|Example:                                                                           |\r
-|curl -u XXXc@csp.abc.com:xxxxx$  -H 'Content-Type:application/json' -X POST -d     |\r
-|@topicname.txt  http://mrlocal00.dcae.proto.research.abc.com:3904/topics/create    |\r
-|{                                                                                  |\r
-|    "writerAcl": {                                                                 |\r
-|        "enabled": false,                                                          |\r
-|        "users": []                                                                |\r
-|    },                                                                             |\r
-|    "description": "This is a TestTopic",                                          |\r
-|    "name": "com.abc.ecomp_test.crm.Load9",                                        |\r
-|    "readerAcl": {                                                                 |\r
-|        "enabled": false,                                                          |\r
-|        "users": []                                                                |\r
-+-----------------------------------------------------------------------------------+\r
 \r
 GetTopic Details\r
 ----------------\r
@@ -387,11 +398,11 @@ GET http(s)://{HOST:PORT}/topics/{topicname} : To list the details of specified
 Request Parameters\r
 ==================\r
 \r
-+--------------------------+---------------------------------+------------------+------------+-----------+-------------+-----------------+-----------------------------+\r
-| Name                     | Description                     | Param Type       | Data type  | Max Len   | Req\92d       | Format          | Valid/EXample values        |\r
-+==========================+=================================+==================+============+===========+=============+=================+=============================+\r
-| Topicname                | topic name details              | Body             | String     | 20        | Y           |  Json           | com.abc.dmaap.mr.metrics    |\r
-+--------------------------+---------------------------------+------------------+------------+-----------+-------------+-----------------+-----------------------------+\r
++--------------------------+-------------------------+------------------+------------+-----------+-------------+-----------------+-----------------------------+\r
+| Name                     | Description             | Param Type       | Data type  | Max Len   | Required    | Format          | Valid/EXample values        |\r
++==========================+=========================+==================+============+===========+=============+=================+=============================+\r
+| Topicname                | topic name details      | Body             | String     | 20        | Y           |  Json           | com.abc.dmaap.mr.metrics    |\r
++--------------------------+-------------------------+------------------+------------+-----------+-------------+-----------------+-----------------------------+\r
 \r
 \r
 Response Parameters\r
@@ -404,10 +415,10 @@ Response Parameters
 +------------------+------------------------+------------+----------+---------+--------------------------+\r
 | description      |                        |            |   String |         |                          | \r
 +------------------+------------------------+------------+----------+---------+--------------------------+\r
-|owner             |user id who created the |            |          |         |                          |\r
+| owner            |user id who created the |            |          |         |                          |\r
 |                  |         topic          |            |          |         |                          | \r
 +------------------+------------------------+------------+----------+---------+--------------------------+\r
-| txenabled        |     true or false      |            |   boolean|         |                          | \r
+| txenabled        |     true or false      |            |  boolean |         |                          | \r
 +------------------+------------------------+------------+----------+---------+--------------------------+\r
 \r
 +---------------------------+------------------------------------+\r
@@ -422,7 +433,7 @@ Response Parameters
 \r
 \r
 Sample Request:\r
-==============\r
+===============\r
 \r
 +-----------------------------------------------------------------------------------+\r
 | GET   http://<hostname>:3904/topic/com.att.dmaap.mr.testtopic                     |\r
@@ -448,12 +459,12 @@ Delete Topics
 -------------\r
 \r
 Request URL:\r
-===========\r
+============\r
 \r
 DELETE http(s)://{HOST:PORT}/topic/{topicname}\r
 \r
 Sample Request:\r
-==============\r
+===============\r
 ex: http://<hostname>:3904/dmaap/v1/topics/com.att.dmaap.mr.testopic\r
 \r
 +---------------------------+------------------------------------+\r
@@ -478,7 +489,8 @@ API Inventory
 +-----------+-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
 |           |   API Name        |   API Method                            |   REST API Path                       |                | Comments                         |\r
 +===========+===================+=========================================+=======================================+================+==================================+\r
-| Topics    | GetAll Topics List|  getTopics()                            | /topics                               | GET            |                                  |\r
+| Topics    | GetAll Topics     |getTopics()                              |/topics                                |GET             |                                  |\r
+|           |List               |                                         |                                       |                |                                  |\r
 |           +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
 |           | Get All Topics    |                                         |                                       |                |                                  |\r
 |           |List with details  | getAllTopics()                          | /topics/listAll                       | GET            |                                  |\r
@@ -490,23 +502,25 @@ API Inventory
 |           +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
 |           | Delete Topic      | deleteTopicString topicName)            | /topics/{topicName}                   | DELETE         |  Not used in current MR version  |\r
 |           +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
-|           | Get Publishers for| getPublishersByTopicName                |                                       |                |                                  |\r
-|           | a Topic           | (String topicName)                      | /topics/{topicName}/producers         | GET            |  UEB Backward Compatibility      |\r
+|           | Get Publishers    | getPublishersByTopicName                |                                       |                |                                  |\r
+|           | for a Topic       | (String topicName)                      | /topics/{topicName}/producers         | GET            |  UEB Backward Compatibility      |\r
 |           +-------------------+-----------------------------------------+---------------------------------------+----------------+                                  |\r
-|           | Add a Publisher to|permitPublisherForTopic(String topicName,| /topics/{topicName}/producers/        |                |                                  |\r
-|           |write ACLon a Topic|     String producerId)                  |    {producerId}                       | PUT            |                                  |\r
+|           | Add a Publisher   |permitPublisherForTopic                  | /topics/{topicName}/producers/        |   PUT          |                                  |\r
+|           |to write ACLon     |(String topicName, String producerId)    | {producerId}                          |                |                                  |\r
+|           |a Topic            |                                         |                                       |                |                                  |\r
 |           +-------------------+-----------------------------------------+---------------------------------------+----------------+                                  |\r
-|           | Remove a Publisher|denyPublisherForTopic(String   topicName,|/topics/{topicName}/producers/         |                |                                  | \r
-|           |from write   ACL on|String producerId)                       |{producerId}                           |   DELETE       |                                  |\r
+|           |Remove a Publisher |denyPublisherForTopic(String   topicName,|/topics/{topicName}/producers/         |                |                                  | \r
+|           |from write ACL on  |String producerId)                       |{producerId}                           |   DELETE       |                                  |\r
 |           | a Topic           |                                         |                                       |                |                                  |\r
 |           +-------------------+-----------------------------------------+---------------------------------------+----------------+                                  |\r
-|           |Get Consumers for a| getConsumersByTopicName                 |  /topics/{topicName}/consumers        |       GET      |                                  |\r
-|           |  Topic            | (String topicName)                      |                                       |                |                                  |\r
+|           |Get Consumers for  | getConsumersByTopicName                 |  /topics/{topicName}/consumers        |       GET      |                                  |\r
+|           | a Topic           | (String topicName)                      |                                       |                |                                  |\r
 |           +-------------------+-----------------------------------------+---------------------------------------+----------------+                                  |\r
-|           | Add a Consumer to | permitConsumerForTopic(String topicName,|   /topics/{topicName}/consumers/      |      PUT       |                                  |\r
-|           |read ACL on a Topic|      String consumerId)                 |       {consumerId}                    |                |                                  |    \r
+|           | Add a Consumer    | permitConsumerForTopic(String topicName,|   /topics/{topicName}/consumers/      |      PUT       |                                  |\r
+|           |to read ACL        |      String consumerId)                 |       {consumerId}                    |                |                                  |\r
+|           |on a Topic         |                                         |                                       |                |                                  |    \r
 |           +-------------------+-----------------------------------------+---------------------------------------+----------------+                                  |\r
 |           | Remove a consumer |denyPublisherForTopic(String   topicName,|/topics/{topicName}/consumers/         |                |                                  | \r
-|           |from write   ACL on|String consumerId)                       |{consumerId}                           |                |                                  |\r
-|           | a Topic           |                                         |                                       |    DELETE      |                                  |\r
+|           |from write         |String consumerId)                       |{consumerId}                           |                |                                  |\r
+|           | ACL on a Topic    |                                         |                                       |    DELETE      |                                  |\r
 +-----------+-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r