This is an automated email from the ASF dual-hosted git repository.
rdhabalia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 1e9c7f52368 [Fix][Doc] Update docs for Partition increase command
(#20035)
1e9c7f52368 is described below
commit 1e9c7f5236866d07105421c566241e3798f63097
Author: Apurva007 <apurvatelan...@gmail.com>
AuthorDate: Tue Apr 11 20:07:45 2023 -0700
[Fix][Doc] Update docs for Partition increase command (#20035)
Co-authored-by: Apurva Telang <atel...@paypal.com>
---
.../org/apache/pulsar/broker/admin/v1/PersistentTopics.java | 4 ++--
.../org/apache/pulsar/broker/admin/v2/PersistentTopics.java | 4 ++--
.../src/main/java/org/apache/pulsar/client/admin/Topics.java | 12 ++++++------
.../org/apache/pulsar/admin/cli/CmdPersistentTopics.java | 2 +-
.../src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java | 2 +-
5 files changed, 12 insertions(+), 12 deletions(-)
diff --git
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v1/PersistentTopics.java
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v1/PersistentTopics.java
index 16f1b357dcd..e9bb1a40547 100644
---
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v1/PersistentTopics.java
+++
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v1/PersistentTopics.java
@@ -256,14 +256,14 @@ public class PersistentTopics extends
PersistentTopicsBase {
}
/**
- * It updates number of partitions of an existing non-global partitioned
topic. It requires partitioned-topic to be
+ * It updates number of partitions of an existing partitioned topic. It
requires partitioned-topic to be
* already exist and number of new partitions must be greater than
existing number of partitions. Decrementing
* number of partitions requires deletion of topic which is not supported.
*/
@POST
@Path("/{property}/{cluster}/{namespace}/{topic}/partitions")
@ApiOperation(hidden = true, value = "Increment partitions of an existing
partitioned topic.",
- notes = "It only increments partitions of existing non-global
partitioned-topic")
+ notes = "It increments partitions of existing partitioned-topic")
@ApiResponses(value = {
@ApiResponse(code = 204, message = "Update topic partition
successful."),
@ApiResponse(code = 307, message = "Current broker doesn't serve
the namespace of this topic"),
diff --git
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/PersistentTopics.java
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/PersistentTopics.java
index 477cc8b5712..eee363aeed8 100644
---
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/PersistentTopics.java
+++
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/PersistentTopics.java
@@ -775,14 +775,14 @@ public class PersistentTopics extends
PersistentTopicsBase {
}
/**
- * It updates number of partitions of an existing non-global partitioned
topic. It requires partitioned-topic to be
+ * It updates number of partitions of an existing partitioned topic. It
requires partitioned-topic to be
* already exist and number of new partitions must be greater than
existing number of partitions. Decrementing
* number of partitions requires deletion of topic which is not supported.
*/
@POST
@Path("/{tenant}/{namespace}/{topic}/partitions")
@ApiOperation(value = "Increment partitions of an existing partitioned
topic.",
- notes = "It only increments partitions of existing non-global
partitioned-topic")
+ notes = "It increments partitions of existing partitioned-topic")
@ApiResponses(value = {
@ApiResponse(code = 204, message = "Update topic partition
successful."),
@ApiResponse(code = 307, message = "Current broker doesn't serve
the namespace of this topic"),
diff --git
a/pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin/Topics.java
b/pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin/Topics.java
index 0d5d14eb734..f599e2566bf 100644
---
a/pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin/Topics.java
+++
b/pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin/Topics.java
@@ -589,7 +589,7 @@ public interface Topics {
CompletableFuture<Void> createMissedPartitionsAsync(String topic);
/**
- * Update number of partitions of a non-global partitioned topic.
+ * Update number of partitions of a partitioned topic.
* <p/>
* It requires partitioned-topic to be already exist and number of new
partitions must be greater than existing
* number of partitions. Decrementing number of partitions requires
deletion of topic which is not supported.
@@ -605,7 +605,7 @@ public interface Topics {
void updatePartitionedTopic(String topic, int numPartitions) throws
PulsarAdminException;
/**
- * Update number of partitions of a non-global partitioned topic
asynchronously.
+ * Update number of partitions of a partitioned topic asynchronously.
* <p/>
* It requires partitioned-topic to be already exist and number of new
partitions must be greater than existing
* number of partitions. Decrementing number of partitions requires
deletion of topic which is not supported.
@@ -621,7 +621,7 @@ public interface Topics {
CompletableFuture<Void> updatePartitionedTopicAsync(String topic, int
numPartitions);
/**
- * Update number of partitions of a non-global partitioned topic.
+ * Update number of partitions of a partitioned topic.
* <p/>
* It requires partitioned-topic to be already exist and number of new
partitions must be greater than existing
* number of partitions. Decrementing number of partitions requires
deletion of topic which is not supported.
@@ -641,7 +641,7 @@ public interface Topics {
throws PulsarAdminException;
/**
- * Update number of partitions of a non-global partitioned topic
asynchronously.
+ * Update number of partitions of a partitioned topic asynchronously.
* <p/>
* It requires partitioned-topic to be already exist and number of new
partitions must be greater than existing
* number of partitions. Decrementing number of partitions requires
deletion of topic which is not supported.
@@ -661,7 +661,7 @@ public interface Topics {
boolean force);
/**
- * Update number of partitions of a non-global partitioned topic.
+ * Update number of partitions of a partitioned topic.
* <p/>
* It requires partitioned-topic to be already exist and number of new
partitions must be greater than existing
* number of partitions. Decrementing number of partitions requires
deletion of topic which is not supported.
@@ -679,7 +679,7 @@ public interface Topics {
throws PulsarAdminException;
/**
- * Update number of partitions of a non-global partitioned topic
asynchronously.
+ * Update number of partitions of a partitioned topic asynchronously.
* <p/>
* It requires partitioned-topic to be already exist and number of new
partitions must be greater than existing
* number of partitions. Decrementing number of partitions requires
deletion of topic which is not supported.
diff --git
a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdPersistentTopics.java
b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdPersistentTopics.java
index 6e59be39c01..3c1662d00a0 100644
---
a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdPersistentTopics.java
+++
b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdPersistentTopics.java
@@ -211,7 +211,7 @@ public class CmdPersistentTopics extends CmdBase {
}
}
- @Parameters(commandDescription = "Update existing non-global partitioned
topic. "
+ @Parameters(commandDescription = "Update existing partitioned topic. "
+ "New updating number of partitions must be greater than existing
number of partitions.")
private class UpdatePartitionedCmd extends CliCommand {
diff --git
a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java
b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java
index 8b11990dc53..f96410749ae 100644
---
a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java
+++
b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java
@@ -585,7 +585,7 @@ public class CmdTopics extends CmdBase {
}
}
- @Parameters(commandDescription = "Update existing non-global partitioned
topic. "
+ @Parameters(commandDescription = "Update existing partitioned topic. "
+ "New updating number of partitions must be greater than existing
number of partitions.")
private class UpdatePartitionedCmd extends CliCommand {
