Skip to content

Commit 70224d9

Browse files
committed
improve doc
1 parent 6f471c3 commit 70224d9

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

pip/pip-452.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Broker: Extend `BrokerInterceptor` to allow plugins to intercept the "Get Topics
1818

1919
Client: Update the Java Client to forward Consumer properties to the lookup service when using Regex subscriptions.
2020

21+
Admin API & CLI: Update the REST API and CLI to accept properties for listing topics in a namespace.
22+
2123
# High Level Design
2224
We will modify the Pulsar Protocol to carry a properties map. On the Broker side, we will add a new method to the BrokerInterceptor interface.
2325
The default implementation will preserve the existing behavior (fetching from ZooKeeper). The Broker's connection handler will simply delegate the request to this strategy.
@@ -49,9 +51,9 @@ message CommandGetTopicsOfNamespace {
4951

5052
Add `properties` parameter to the REST API endpoint for listing topics in a namespace to list topic with specific properties for customizable topic listing.
5153

52-
REST API:
54+
REST API (URL encoding is required for values):
5355
```
54-
GET /admin/v2/persistent/{tenant}/{namespace} with a query params properties=k1=v1,k2=v2
56+
GET /admin/v2/persistent/{tenant}/{namespace}?properties=k1=v1,k2=v2
5557
```
5658

5759
CLI:
@@ -212,14 +214,15 @@ The regex consumer implementation (PatternMultiTopicsConsumerImpl) will be updat
212214

213215
```Java
214216
// In PatternMultiTopicsConsumerImpl.java
217+
ConsumerConfigurationData conf;
215218
Map<String, String> contextProperties = conf.getProperties();
216219

217220
lookup.getTopicsUnderNamespace(
218221
namespace,
219222
mode,
220223
topicsPattern.pattern(),
221224
topicsHash,
222-
contextProperties // Pass properties here
225+
contextProperties // Pass consumer properties here
223226
).thenAccept(topics -> {
224227
// ... update subscriptions ...
225228
});
@@ -238,5 +241,5 @@ Authorization: This PIP only controls the discovery (listing) of topics. It does
238241

239242
# Links
240243

241-
* Mailing List discussion thread:
244+
* Mailing List discussion thread: https://lists.apache.org/thread/nf11qzn6r9wps6l81trxwtdr1m9xszpm
242245
* Mailing List voting thread:

0 commit comments

Comments
 (0)