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