correct documentation rst file errors and warnings
[dmaap/messagerouter/messageservice.git] / docs / Filter / Filter.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