You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ba...@apache.org on 2024/05/28 01:21:02 UTC
(pulsar) branch branch-3.0 updated: [fix][admin] Clearly define REST API on Open API for Namesaces@v2 (#22775)
This is an automated email from the ASF dual-hosted git repository.
baodi pushed a commit to branch branch-3.0
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/branch-3.0 by this push:
new 7558b2d3c4b [fix][admin] Clearly define REST API on Open API for Namesaces@v2 (#22775)
7558b2d3c4b is described below
commit 7558b2d3c4bd968734887087482bf76e113348d4
Author: Baodi Shi <ba...@apache.org>
AuthorDate: Mon May 27 21:37:24 2024 +0800
[fix][admin] Clearly define REST API on Open API for Namesaces@v2 (#22775)
(cherry picked from commit 9b3876df70f3b1d8bc01a34308d718c456f1781b)
---
.../apache/pulsar/broker/admin/v2/Namespaces.java | 442 +++++++++++++++------
1 file changed, 318 insertions(+), 124 deletions(-)
diff --git a/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Namespaces.java b/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Namespaces.java
index 7339ec7e9a3..d673d925e77 100644
--- a/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Namespaces.java
+++ b/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Namespaces.java
@@ -24,6 +24,8 @@ import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
+import io.swagger.annotations.Example;
+import io.swagger.annotations.ExampleProperty;
import java.io.OutputStreamWriter;
import java.nio.charset.StandardCharsets;
import java.util.HashSet;
@@ -59,9 +61,11 @@ import org.apache.pulsar.common.policies.data.BacklogQuota;
import org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType;
import org.apache.pulsar.common.policies.data.BookieAffinityGroupData;
import org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies;
+import org.apache.pulsar.common.policies.data.DispatchRate;
import org.apache.pulsar.common.policies.data.EntryFilters;
import org.apache.pulsar.common.policies.data.InactiveTopicPolicies;
import org.apache.pulsar.common.policies.data.NamespaceOperation;
+import org.apache.pulsar.common.policies.data.OffloadPolicies;
import org.apache.pulsar.common.policies.data.OffloadPoliciesImpl;
import org.apache.pulsar.common.policies.data.PersistencePolicies;
import org.apache.pulsar.common.policies.data.Policies;
@@ -73,6 +77,12 @@ import org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrat
import org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy;
import org.apache.pulsar.common.policies.data.SubscribeRate;
import org.apache.pulsar.common.policies.data.SubscriptionAuthMode;
+import org.apache.pulsar.common.policies.data.TopicHashPositions;
+import org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl;
+import org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl;
+import org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl;
+import org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl;
+import org.apache.pulsar.common.policies.data.impl.BundlesDataImpl;
import org.apache.pulsar.common.policies.data.impl.DispatchRateImpl;
import org.apache.pulsar.common.util.FutureUtil;
import org.apache.pulsar.metadata.api.MetadataStoreException;
@@ -152,7 +162,9 @@ public class Namespaces extends NamespacesBase {
@PUT
@Path("/{tenant}/{namespace}")
@ApiOperation(value = "Creates a new namespace with the specified policies")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster doesn't exist"),
@ApiResponse(code = 409, message = "Namespace already exists"),
@ApiResponse(code = 412, message = "Namespace name is not valid") })
@@ -180,6 +192,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}")
@ApiOperation(value = "Delete a namespace and all the topics under it.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 307, message = "Current broker doesn't serve the namespace"),
@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@@ -208,6 +221,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/{bundle}")
@ApiOperation(value = "Delete a namespace bundle and all the topics under it.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 307, message = "Current broker doesn't serve the namespace"),
@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@@ -231,7 +245,10 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/permissions")
- @ApiOperation(value = "Retrieve the permissions for a namespace.")
+ @ApiOperation(value = "Retrieve the permissions for a namespace.",
+ notes = "Returns a nested map structure which Swagger does not fully support for display. "
+ + "Structure: Map<String, Set<AuthAction>>. Please refer to this structure for details.",
+ response = AuthAction.class, responseContainer = "Map")
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 409, message = "Namespace is not empty") })
@@ -251,7 +268,10 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/permissions/subscription")
- @ApiOperation(value = "Retrieve the permissions for a subscription.")
+ @ApiOperation(value = "Retrieve the permissions for a subscription.",
+ notes = "Returns a nested map structure which Swagger does not fully support for display. "
+ + "Structure: Map<String, Set<String>>. Please refer to this structure for details.",
+ response = String.class, responseContainer = "Map")
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 409, message = "Namespace is not empty")})
@@ -273,7 +293,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/permissions/{role}")
@ApiOperation(value = "Grant a new permission to a role on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 501, message = "Authorization is not enabled")})
@@ -297,7 +319,9 @@ public class Namespaces extends NamespacesBase {
@Path("/{property}/{namespace}/permissions/subscription/{subscription}")
@ApiOperation(hidden = true, value = "Grant a new permission to roles for a subscription."
+ "[Tenant admin is allowed to perform this operation]")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Property or cluster or namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 501, message = "Authorization is not enabled") })
@@ -321,7 +345,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/permissions/{role}")
@ApiOperation(value = "Revoke all permissions to a role on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist") })
public void revokePermissionsOnNamespace(@Suspended AsyncResponse asyncResponse,
@PathParam("tenant") String tenant,
@@ -340,7 +366,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{property}/{namespace}/permissions/{subscription}/{role}")
@ApiOperation(hidden = true, value = "Revoke subscription admin-api access permission for a role.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Property or cluster or namespace doesn't exist") })
public void revokePermissionOnSubscription(@Suspended AsyncResponse asyncResponse,
@PathParam("property") String property,
@@ -360,7 +388,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/replication")
@ApiOperation(value = "Get the replication clusters for a namespace.",
- response = String.class, responseContainer = "List")
+ response = String.class, responseContainer = "Set")
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 412, message = "Namespace is not global")})
@@ -381,7 +409,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/replication")
@ApiOperation(value = "Set the replication clusters for a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 409, message = "Peer-cluster can't be part of replication-cluster"),
@ApiResponse(code = 412, message = "Namespace is not global or invalid cluster ids") })
@@ -422,7 +452,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/messageTTL")
@ApiOperation(value = "Set message TTL in seconds for namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 412, message = "Invalid TTL") })
public void setNamespaceMessageTTL(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@@ -442,7 +474,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/messageTTL")
@ApiOperation(value = "Remove message TTL in seconds for namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 412, message = "Invalid TTL")})
public void removeNamespaceMessageTTL(@Suspended AsyncResponse asyncResponse,
@@ -460,7 +494,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/subscriptionExpirationTime")
- @ApiOperation(value = "Get the subscription expiration time for the namespace")
+ @ApiOperation(value = "Get the subscription expiration time for the namespace", response = Integer.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist") })
public void getSubscriptionExpirationTime(@Suspended AsyncResponse asyncResponse,
@@ -482,7 +516,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/subscriptionExpirationTime")
@ApiOperation(value = "Set subscription expiration time in minutes for namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 412, message = "Invalid expiration time")})
public void setSubscriptionExpirationTime(@Suspended AsyncResponse asyncResponse,
@@ -505,7 +541,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/subscriptionExpirationTime")
@ApiOperation(value = "Remove subscription expiration time for namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist")})
public void removeSubscriptionExpirationTime(@Suspended AsyncResponse asyncResponse,
@PathParam("tenant") String tenant,
@@ -523,7 +561,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/deduplication")
- @ApiOperation(value = "Get broker side deduplication for all topics in a namespace")
+ @ApiOperation(value = "Get broker side deduplication for all topics in a namespace", response = Boolean.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist") })
public void getDeduplication(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@@ -541,7 +579,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/deduplication")
@ApiOperation(value = "Enable or disable broker side deduplication for all topics in a namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist") })
public void modifyDeduplication(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
@@ -561,7 +601,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/deduplication")
@ApiOperation(value = "Remove broker side deduplication for all topics in a namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist") })
public void removeDeduplication(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
@@ -578,7 +620,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/autoTopicCreation")
- @ApiOperation(value = "Get autoTopicCreation info in a namespace")
+ @ApiOperation(value = "Get autoTopicCreation info in a namespace", response = AutoTopicCreationOverrideImpl.class)
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist")})
public void getAutoTopicCreation(@Suspended AsyncResponse asyncResponse,
@@ -597,7 +639,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/autoTopicCreation")
@ApiOperation(value = "Override broker's allowAutoTopicCreation setting for a namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 406, message = "The number of partitions should be less than or"
+ " equal to maxNumPartitionsPerPartitionedTopic"),
@@ -633,7 +677,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/autoTopicCreation")
@ApiOperation(value = "Remove override of broker's allowAutoTopicCreation in a namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist") })
public void removeAutoTopicCreation(@Suspended final AsyncResponse asyncResponse,
@PathParam("tenant") String tenant, @PathParam("namespace") String namespace) {
@@ -661,7 +707,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/autoSubscriptionCreation")
@ApiOperation(value = "Override broker's allowAutoSubscriptionCreation setting for a namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 400, message = "Invalid autoSubscriptionCreation override")})
public void setAutoSubscriptionCreation(
@@ -691,7 +739,8 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/autoSubscriptionCreation")
- @ApiOperation(value = "Get autoSubscriptionCreation info in a namespace")
+ @ApiOperation(value = "Get autoSubscriptionCreation info in a namespace",
+ response = AutoSubscriptionCreationOverrideImpl.class)
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist")})
public void getAutoSubscriptionCreation(@Suspended final AsyncResponse asyncResponse,
@@ -710,7 +759,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/autoSubscriptionCreation")
@ApiOperation(value = "Remove override of broker's allowAutoSubscriptionCreation in a namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist") })
public void removeAutoSubscriptionCreation(@Suspended final AsyncResponse asyncResponse,
@PathParam("tenant") String tenant, @PathParam("namespace") String namespace) {
@@ -736,7 +787,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/bundles")
- @ApiOperation(value = "Get the bundles split data.")
+ @ApiOperation(value = "Get the bundles split data.", response = BundlesDataImpl.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 412, message = "Namespace is not setup to split in bundles") })
@@ -768,6 +819,7 @@ public class Namespaces extends NamespacesBase {
+ " since it wouldresult in non-persistent message loss and"
+ " unexpected connection closure to the clients.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 307, message = "Current broker doesn't serve the namespace"),
@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist"),
@@ -800,6 +852,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/{bundle}/unload")
@ApiOperation(value = "Unload a namespace bundle")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 307, message = "Current broker doesn't serve the namespace"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 403, message = "Don't have admin permission") })
@@ -829,6 +882,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/{bundle}/split")
@ApiOperation(value = "Split a namespace bundle")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 307, message = "Current broker doesn't serve the namespace"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 403, message = "Don't have admin permission") })
@@ -865,7 +919,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/{bundle}/topicHashPositions")
- @ApiOperation(value = "Get hash positions for topics")
+ @ApiOperation(value = "Get hash positions for topics", response = TopicHashPositions.class)
@ApiResponses(value = {
@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist")})
@@ -891,7 +945,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{property}/{namespace}/publishRate")
@ApiOperation(hidden = true, value = "Set publish-rate throttling for all topics of the namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission") })
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission") })
public void setPublishRate(@Suspended AsyncResponse asyncResponse, @PathParam("property") String property,
@PathParam("namespace") String namespace,
@ApiParam(value = "Publish rate for all topics of the specified namespace") PublishRate publishRate) {
@@ -907,7 +963,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{property}/{namespace}/publishRate")
@ApiOperation(hidden = true, value = "Set publish-rate throttling for all topics of the namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission") })
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission") })
public void removePublishRate(@Suspended AsyncResponse asyncResponse, @PathParam("property") String property,
@PathParam("namespace") String namespace) {
validateNamespaceName(property, namespace);
@@ -925,7 +983,8 @@ public class Namespaces extends NamespacesBase {
@Path("/{property}/{namespace}/publishRate")
@ApiOperation(hidden = true,
value = "Get publish-rate configured for the namespace, null means publish-rate not configured, "
- + "-1 means msg-publish-rate or byte-publish-rate not configured in publish-rate yet")
+ + "-1 means msg-publish-rate or byte-publish-rate not configured in publish-rate yet",
+ response = PublishRate.class)
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist")})
public void getPublishRate(@Suspended AsyncResponse asyncResponse,
@@ -944,7 +1003,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/dispatchRate")
@ApiOperation(value = "Set dispatch-rate throttling for all topics of the namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission") })
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission") })
public void setDispatchRate(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
@ApiParam(value = "Dispatch rate for all topics of the specified namespace")
@@ -963,7 +1024,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/dispatchRate")
@ApiOperation(value = "Delete dispatch-rate throttling for all topics of the namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission") })
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission") })
public void deleteDispatchRate(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
validateNamespaceName(tenant, namespace);
@@ -980,7 +1043,8 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/dispatchRate")
@ApiOperation(value = "Get dispatch-rate configured for the namespace, null means dispatch-rate not configured, "
- + "-1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet")
+ + "-1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet",
+ response = DispatchRate.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getDispatchRate(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@@ -997,7 +1061,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/subscriptionDispatchRate")
@ApiOperation(value = "Set Subscription dispatch-rate throttling for all topics of the namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission")})
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission")})
public void setSubscriptionDispatchRate(@Suspended AsyncResponse asyncResponse,
@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
@@ -1019,7 +1085,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/subscriptionDispatchRate")
@ApiOperation(value = "Get subscription dispatch-rate configured for the namespace, null means subscription "
+ "dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured "
- + "in dispatch-rate yet")
+ + "in dispatch-rate yet", response = DispatchRate.class)
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist")})
public void getSubscriptionDispatchRate(@Suspended AsyncResponse asyncResponse,
@@ -1039,7 +1105,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/subscriptionDispatchRate")
@ApiOperation(value = "Delete Subscription dispatch-rate throttling for all topics of the namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission") })
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission") })
public void deleteSubscriptionDispatchRate(@Suspended AsyncResponse asyncResponse,
@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
@@ -1057,7 +1125,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/subscribeRate")
@ApiOperation(value = "Delete subscribe-rate throttling for all topics of the namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission")})
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission")})
public void deleteSubscribeRate(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
validateNamespaceName(tenant, namespace);
@@ -1074,7 +1144,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/subscribeRate")
@ApiOperation(value = "Set subscribe-rate throttling for all topics of the namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission")})
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission")})
public void setSubscribeRate(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
@ApiParam(value = "Subscribe rate for all topics of the specified namespace")
@@ -1092,7 +1164,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/subscribeRate")
- @ApiOperation(value = "Get subscribe-rate configured for the namespace")
+ @ApiOperation(value = "Get subscribe-rate configured for the namespace", response = SubscribeRate.class)
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist")})
public void getSubscribeRate(@Suspended AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@@ -1110,7 +1182,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/replicatorDispatchRate")
@ApiOperation(value = "Remove replicator dispatch-rate throttling for all topics of the namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission")})
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission")})
public void removeReplicatorDispatchRate(@Suspended AsyncResponse asyncResponse,
@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
@@ -1121,7 +1195,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/replicatorDispatchRate")
@ApiOperation(value = "Set replicator dispatch-rate throttling for all topics of the namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission")})
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission")})
public void setReplicatorDispatchRate(@Suspended AsyncResponse asyncResponse,
@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
@@ -1135,7 +1211,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/replicatorDispatchRate")
@ApiOperation(value = "Get replicator dispatch-rate configured for the namespace, null means replicator "
+ "dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured "
- + "in dispatch-rate yet")
+ + "in dispatch-rate yet", response = DispatchRateImpl.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getReplicatorDispatchRate(@Suspended final AsyncResponse asyncResponse,
@@ -1147,7 +1223,8 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/backlogQuotaMap")
- @ApiOperation(value = "Get backlog quota map on a namespace.")
+ @ApiOperation(value = "Get backlog quota map on a namespace.",
+ response = BacklogQuotaImpl.class, responseContainer = "Map")
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getBacklogQuotaMap(
@@ -1161,7 +1238,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/backlogQuota")
@ApiOperation(value = " Set a backlog quota for all the topics on a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412,
@@ -1179,7 +1258,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/backlogQuota")
@ApiOperation(value = "Remove a backlog quota policy from a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
public void removeBacklogQuota(
@@ -1192,7 +1273,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/retention")
- @ApiOperation(value = "Get retention config on a namespace.")
+ @ApiOperation(value = "Get retention config on a namespace.", response = RetentionPolicies.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getRetention(@Suspended final AsyncResponse asyncResponse,
@@ -1213,7 +1294,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/retention")
@ApiOperation(value = " Set retention configuration on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "Retention Quota must exceed backlog quota") })
@@ -1226,7 +1309,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/retention")
@ApiOperation(value = " Remove retention configuration on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "Retention Quota must exceed backlog quota") })
@@ -1239,7 +1324,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/persistence")
@ApiOperation(value = "Set the persistence configuration for all the topics on a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 400, message = "Invalid persistence policies")})
@@ -1261,7 +1348,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/persistence")
@ApiOperation(value = "Delete the persistence configuration for all topics on a namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission") })
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission") })
public void deletePersistence(@Suspended final AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
validateNamespaceName(tenant, namespace);
@@ -1279,6 +1368,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/persistence/bookieAffinity")
@ApiOperation(value = "Set the bookie-affinity-group to namespace-persistent policy.")
@ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
@ApiResponse(code = 307, message = "Current broker doesn't serve the namespace"),
@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@@ -1292,7 +1382,8 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{property}/{namespace}/persistence/bookieAffinity")
- @ApiOperation(value = "Get the bookie-affinity-group from namespace-local policy.")
+ @ApiOperation(value = "Get the bookie-affinity-group from namespace-local policy.",
+ response = BookieAffinityGroupDataImpl.class)
@ApiResponses(value = {
@ApiResponse(code = 307, message = "Current broker doesn't serve the namespace"),
@ApiResponse(code = 403, message = "Don't have admin permission"),
@@ -1307,7 +1398,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{property}/{namespace}/persistence/bookieAffinity")
@ApiOperation(value = "Delete the bookie-affinity-group from namespace-local policy.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
public void deleteBookieAffinityGroup(@PathParam("property") String property,
@@ -1318,7 +1411,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/persistence")
- @ApiOperation(value = "Get the persistence configuration for a namespace.")
+ @ApiOperation(value = "Get the persistence configuration for a namespace.", response = PersistencePolicies.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
@@ -1342,6 +1435,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/clearBacklog")
@ApiOperation(value = "Clear backlog for all topics on a namespace.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 403, message = "Don't have admin or operate permission on the namespace"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void clearNamespaceBacklog(@Suspended final AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@@ -1361,6 +1455,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/{bundle}/clearBacklog")
@ApiOperation(value = "Clear backlog for all topics on a namespace bundle.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 307, message = "Current broker doesn't serve the namespace"),
@ApiResponse(code = 403, message = "Don't have admin or operate permission on the namespace"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
@@ -1375,6 +1470,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/clearBacklog/{subscription}")
@ApiOperation(value = "Clear backlog for a given subscription on all topics on a namespace.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 403, message = "Don't have admin or operate permission on the namespace"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void clearNamespaceBacklogForSubscription(@Suspended final AsyncResponse asyncResponse,
@@ -1395,6 +1491,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription}")
@ApiOperation(value = "Clear backlog for a given subscription on all topics on a namespace bundle.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 307, message = "Current broker doesn't serve the namespace"),
@ApiResponse(code = 403, message = "Don't have admin or operate permission on the namespace"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
@@ -1410,6 +1507,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/unsubscribe/{subscription}")
@ApiOperation(value = "Unsubscribes the given subscription on all topics on a namespace.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 403, message = "Don't have admin or operate permission on the namespacen"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void unsubscribeNamespace(@Suspended final AsyncResponse asyncResponse, @PathParam("tenant") String tenant,
@@ -1430,6 +1528,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription}")
@ApiOperation(value = "Unsubscribes the given subscription on all topics on a namespace bundle.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 403, message = "Don't have admin or operate permission on the namespace"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void unsubscribeNamespaceBundle(@PathParam("tenant") String tenant,
@@ -1443,7 +1542,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/subscriptionAuthMode")
@ApiOperation(value = " Set a subscription auth mode for all the topics on a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification")})
public void setSubscriptionAuthMode(@PathParam("tenant") String tenant,
@@ -1456,7 +1557,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/subscriptionAuthMode")
- @ApiOperation(value = "Get subscription auth mode in a namespace")
+ @ApiOperation(value = "Get subscription auth mode in a namespace", response = SubscriptionAuthMode.class)
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist")})
public void getSubscriptionAuthMode(
@@ -1478,7 +1579,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/encryptionRequired")
@ApiOperation(value = "Message encryption is required or not for all topics in a namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification"), })
public void modifyEncryptionRequired(
@@ -1492,7 +1595,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/encryptionRequired")
- @ApiOperation(value = "Get message encryption required status in a namespace")
+ @ApiOperation(value = "Get message encryption required status in a namespace", response = Boolean.class)
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist")})
public void getEncryptionRequired(@Suspended AsyncResponse asyncResponse,
@@ -1512,7 +1615,8 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/delayedDelivery")
- @ApiOperation(value = "Get delayed delivery messages config on a namespace.")
+ @ApiOperation(value = "Get delayed delivery messages config on a namespace.",
+ response = DelayedDeliveryPolicies.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification"), })
@@ -1534,7 +1638,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/delayedDelivery")
@ApiOperation(value = "Set delayed delivery messages config on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"), })
public void setDelayedDeliveryPolicies(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
@@ -1547,7 +1653,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/delayedDelivery")
@ApiOperation(value = "Delete delayed delivery messages config on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"), })
public void removeDelayedDeliveryPolicies(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
@@ -1557,7 +1665,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/inactiveTopicPolicies")
- @ApiOperation(value = "Get inactive topic policies config on a namespace.")
+ @ApiOperation(value = "Get inactive topic policies config on a namespace.", response = InactiveTopicPolicies.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification"), })
@@ -1579,7 +1687,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/inactiveTopicPolicies")
@ApiOperation(value = "Remove inactive topic policies from a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification")})
public void removeInactiveTopicPolicies(@PathParam("tenant") String tenant,
@@ -1591,7 +1701,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/inactiveTopicPolicies")
@ApiOperation(value = "Set inactive topic policies config on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"), })
public void setInactiveTopicPolicies(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
@@ -1603,7 +1715,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/maxProducersPerTopic")
- @ApiOperation(value = "Get maxProducersPerTopic config on a namespace.")
+ @ApiOperation(value = "Get maxProducersPerTopic config on a namespace.", response = Integer.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getMaxProducersPerTopic(
@@ -1625,7 +1737,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/maxProducersPerTopic")
@ApiOperation(value = " Set maxProducersPerTopic configuration on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "maxProducersPerTopic value is not valid") })
@@ -1638,7 +1752,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/maxProducersPerTopic")
@ApiOperation(value = "Remove maxProducersPerTopic configuration on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
public void removeMaxProducersPerTopic(@PathParam("tenant") String tenant,
@@ -1649,7 +1765,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/deduplicationSnapshotInterval")
- @ApiOperation(value = "Get deduplicationSnapshotInterval config on a namespace.")
+ @ApiOperation(value = "Get deduplicationSnapshotInterval config on a namespace.", response = Integer.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getDeduplicationSnapshotInterval(
@@ -1671,7 +1787,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/deduplicationSnapshotInterval")
@ApiOperation(value = "Set deduplicationSnapshotInterval config on a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist")})
public void setDeduplicationSnapshotInterval(@PathParam("tenant") String tenant
, @PathParam("namespace") String namespace
@@ -1683,7 +1801,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/maxConsumersPerTopic")
- @ApiOperation(value = "Get maxConsumersPerTopic config on a namespace.")
+ @ApiOperation(value = "Get maxConsumersPerTopic config on a namespace.", response = Integer.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getMaxConsumersPerTopic(
@@ -1705,7 +1823,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/maxConsumersPerTopic")
@ApiOperation(value = " Set maxConsumersPerTopic configuration on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "maxConsumersPerTopic value is not valid") })
@@ -1718,7 +1838,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/maxConsumersPerTopic")
@ApiOperation(value = "Remove maxConsumersPerTopic configuration on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
public void removeMaxConsumersPerTopic(@PathParam("tenant") String tenant,
@@ -1729,7 +1851,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/maxConsumersPerSubscription")
- @ApiOperation(value = "Get maxConsumersPerSubscription config on a namespace.")
+ @ApiOperation(value = "Get maxConsumersPerSubscription config on a namespace.", response = Integer.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getMaxConsumersPerSubscription(
@@ -1751,7 +1873,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/maxConsumersPerSubscription")
@ApiOperation(value = " Set maxConsumersPerSubscription configuration on a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "maxConsumersPerSubscription value is not valid")})
@@ -1767,7 +1891,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/maxConsumersPerSubscription")
@ApiOperation(value = " Set maxConsumersPerSubscription configuration on a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "maxConsumersPerSubscription value is not valid")})
@@ -1779,7 +1905,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/maxUnackedMessagesPerConsumer")
- @ApiOperation(value = "Get maxUnackedMessagesPerConsumer config on a namespace.")
+ @ApiOperation(value = "Get maxUnackedMessagesPerConsumer config on a namespace.", response = Integer.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getMaxUnackedMessagesPerConsumer(@Suspended final AsyncResponse asyncResponse,
@@ -1800,7 +1926,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/maxUnackedMessagesPerConsumer")
@ApiOperation(value = " Set maxConsumersPerTopic configuration on a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "maxUnackedMessagesPerConsumer value is not valid")})
@@ -1816,7 +1944,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/maxUnackedMessagesPerConsumer")
@ApiOperation(value = "Remove maxUnackedMessagesPerConsumer config on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void removeMaxUnackedmessagesPerConsumer(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
@@ -1826,7 +1956,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/maxUnackedMessagesPerSubscription")
- @ApiOperation(value = "Get maxUnackedMessagesPerSubscription config on a namespace.")
+ @ApiOperation(value = "Get maxUnackedMessagesPerSubscription config on a namespace.", response = Integer.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getMaxUnackedmessagesPerSubscription(
@@ -1848,7 +1978,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/maxUnackedMessagesPerSubscription")
@ApiOperation(value = " Set maxUnackedMessagesPerSubscription configuration on a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "maxUnackedMessagesPerSubscription value is not valid")})
@@ -1863,7 +1995,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/maxUnackedMessagesPerSubscription")
@ApiOperation(value = "Remove maxUnackedMessagesPerSubscription config on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void removeMaxUnackedmessagesPerSubscription(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
@@ -1873,7 +2007,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/maxSubscriptionsPerTopic")
- @ApiOperation(value = "Get maxSubscriptionsPerTopic config on a namespace.")
+ @ApiOperation(value = "Get maxSubscriptionsPerTopic config on a namespace.", response = Integer.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getMaxSubscriptionsPerTopic(@Suspended final AsyncResponse asyncResponse,
@@ -1894,7 +2028,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/maxSubscriptionsPerTopic")
@ApiOperation(value = " Set maxSubscriptionsPerTopic configuration on a namespace.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "maxUnackedMessagesPerSubscription value is not valid")})
@@ -1909,7 +2045,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/maxSubscriptionsPerTopic")
@ApiOperation(value = "Remove maxSubscriptionsPerTopic configuration on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
public void removeMaxSubscriptionsPerTopic(@PathParam("tenant") String tenant,
@@ -1921,7 +2059,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/antiAffinity")
@ApiOperation(value = "Set anti-affinity group for a namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 412, message = "Invalid antiAffinityGroup")})
public void setNamespaceAntiAffinityGroup(@PathParam("tenant") String tenant,
@@ -1935,7 +2075,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/antiAffinity")
- @ApiOperation(value = "Get anti-affinity group of a namespace.")
+ @ApiOperation(value = "Get anti-affinity group of a namespace.", response = String.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist") })
public String getNamespaceAntiAffinityGroup(@PathParam("tenant") String tenant,
@@ -1947,7 +2087,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/antiAffinity")
@ApiOperation(value = "Remove anti-affinity group of a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
public void removeNamespaceAntiAffinityGroup(@PathParam("tenant") String tenant,
@@ -1959,7 +2101,8 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("{cluster}/antiAffinity/{group}")
@ApiOperation(value = "Get all namespaces that are grouped by given anti-affinity group in a given cluster."
- + " api can be only accessed by admin of any of the existing tenant")
+ + " api can be only accessed by admin of any of the existing tenant",
+ response = String.class, responseContainer = "List")
@ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 412, message = "Cluster not exist/Anti-affinity group can't be empty.")})
public List<String> getAntiAffinityNamespaces(@PathParam("cluster") String cluster,
@@ -1985,7 +2128,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/compactionThreshold")
@ApiOperation(value = "Maximum number of uncompacted bytes in topics before compaction is triggered.",
notes = "The backlog size is compared to the threshold periodically. "
- + "A threshold of 0 disabled automatic compaction")
+ + "A threshold of 0 disabled automatic compaction", response = Long.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist") })
public void getCompactionThreshold(
@@ -2009,7 +2152,9 @@ public class Namespaces extends NamespacesBase {
@ApiOperation(value = "Set maximum number of uncompacted bytes in a topic before compaction is triggered.",
notes = "The backlog size is compared to the threshold periodically. "
+ "A threshold of 0 disabled automatic compaction")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "compactionThreshold value is not valid")})
@@ -2027,7 +2172,9 @@ public class Namespaces extends NamespacesBase {
@ApiOperation(value = "Delete maximum number of uncompacted bytes in a topic before compaction is triggered.",
notes = "The backlog size is compared to the threshold periodically. "
+ "A threshold of 0 disabled automatic compaction")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification")})
public void deleteCompactionThreshold(@PathParam("tenant") String tenant,
@@ -2040,7 +2187,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/offloadThreshold")
@ApiOperation(value = "Maximum number of bytes stored on the pulsar cluster for a topic,"
+ " before the broker will start offloading to longterm storage",
- notes = "A negative value disables automatic offloading")
+ notes = "A negative value disables automatic offloading", response = Long.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist") })
public void getOffloadThreshold(
@@ -2071,7 +2218,9 @@ public class Namespaces extends NamespacesBase {
+ " before the broker will start offloading to longterm storage",
notes = "-1 will revert to using the cluster default."
+ " A negative value disables automatic offloading. ")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "offloadThreshold value is not valid")})
@@ -2089,7 +2238,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/offloadThresholdInSeconds")
@ApiOperation(value = "Maximum number of bytes stored on the pulsar cluster for a topic,"
+ " before the broker will start offloading to longterm storage",
- notes = "A negative value disables automatic offloading")
+ notes = "A negative value disables automatic offloading", response = Long.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist") })
public void getOffloadThresholdInSeconds(
@@ -2119,7 +2268,9 @@ public class Namespaces extends NamespacesBase {
@ApiOperation(value = "Set maximum number of seconds stored on the pulsar cluster for a topic,"
+ " before the broker will start offloading to longterm storage",
notes = "A negative value disables automatic offloading")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "offloadThresholdInSeconds value is not valid") })
@@ -2143,7 +2294,7 @@ public class Namespaces extends NamespacesBase {
+ " from the Pulsar cluster's local storage (i.e. BookKeeper)",
notes = "A negative value denotes that deletion has been completely disabled."
+ " 'null' denotes that the topics in the namespace will fall back to the"
- + " broker default for deletion lag.")
+ + " broker default for deletion lag.", response = Long.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist") })
public void getOffloadDeletionLag(
@@ -2173,7 +2324,9 @@ public class Namespaces extends NamespacesBase {
@ApiOperation(value = "Set number of milliseconds to wait before deleting a ledger segment which has been offloaded"
+ " from the Pulsar cluster's local storage (i.e. BookKeeper)",
notes = "A negative value disables the deletion completely.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@ApiResponse(code = 412, message = "offloadDeletionLagMs value is not valid")})
@@ -2192,6 +2345,7 @@ public class Namespaces extends NamespacesBase {
@ApiOperation(value = "Clear the namespace configured offload deletion lag. The topics in the namespace"
+ " will fallback to using the default configured deletion lag for the broker")
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponse(code = 200, message = "Operation successful"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
public void clearOffloadDeletionLag(@PathParam("tenant") String tenant,
@@ -2205,7 +2359,8 @@ public class Namespaces extends NamespacesBase {
@ApiOperation(value = "The strategy used to check the compatibility of new schemas,"
+ " provided by producers, before automatically updating the schema",
notes = "The value AutoUpdateDisabled prevents producers from updating the schema. "
- + " If set to AutoUpdateDisabled, schemas must be updated through the REST api")
+ + " If set to AutoUpdateDisabled, schemas must be updated through the REST api",
+ response = SchemaAutoUpdateCompatibilityStrategy.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
@@ -2222,7 +2377,9 @@ public class Namespaces extends NamespacesBase {
+ " provided by producers, before automatically updating the schema",
notes = "The value AutoUpdateDisabled prevents producers from updating the schema. "
+ " If set to AutoUpdateDisabled, schemas must be updated through the REST api")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification")})
public void setSchemaAutoUpdateCompatibilityStrategy(
@@ -2236,7 +2393,8 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/schemaCompatibilityStrategy")
- @ApiOperation(value = "The strategy of the namespace schema compatibility ")
+ @ApiOperation(value = "The strategy of the namespace schema compatibility ",
+ response = SchemaCompatibilityStrategy.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
@@ -2260,7 +2418,9 @@ public class Namespaces extends NamespacesBase {
@PUT
@Path("/{tenant}/{namespace}/schemaCompatibilityStrategy")
@ApiOperation(value = "Update the strategy used to check the compatibility of new schema")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification")})
public void setSchemaCompatibilityStrategy(
@@ -2274,7 +2434,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/isAllowAutoUpdateSchema")
- @ApiOperation(value = "The flag of whether allow auto update schema")
+ @ApiOperation(value = "The flag of whether allow auto update schema", response = Boolean.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
@@ -2304,7 +2464,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/isAllowAutoUpdateSchema")
@ApiOperation(value = "Update flag of whether allow auto update schema")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification")})
public void setIsAllowAutoUpdateSchema(
@@ -2318,7 +2480,8 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/subscriptionTypesEnabled")
- @ApiOperation(value = "The set of whether allow subscription types")
+ @ApiOperation(value = "The set of whether allow subscription types",
+ response = SubscriptionType.class, responseContainer = "Set")
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification") })
@@ -2346,7 +2509,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/subscriptionTypesEnabled")
@ApiOperation(value = "Update set of whether allow share sub type")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist"),
@ApiResponse(code = 409, message = "Concurrent modification")})
public void setSubscriptionTypesEnabled(
@@ -2377,7 +2542,8 @@ public class Namespaces extends NamespacesBase {
notes = "If the flag is set to true, when a producer without a schema attempts to produce to a topic"
+ " with schema in this namespace, the producer will be failed to connect. PLEASE be"
+ " carefully on using this, since non-java clients don't support schema.if you enable"
- + " this setting, it will cause non-java clients failed to produce.")
+ + " this setting, it will cause non-java clients failed to produce.",
+ response = Boolean.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenants or Namespace doesn't exist") })
public void getSchemaValidtionEnforced(
@@ -2412,7 +2578,9 @@ public class Namespaces extends NamespacesBase {
+ " with schema in this namespace, the producer will be failed to connect. PLEASE be"
+ " carefully on using this, since non-java clients don't support schema.if you enable"
+ " this setting, it will cause non-java clients failed to produce.")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or Namespace doesn't exist"),
@ApiResponse(code = 412, message = "schemaValidationEnforced value is not valid")})
public void setSchemaValidationEnforced(@PathParam("tenant") String tenant,
@@ -2427,8 +2595,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/offloadPolicies")
- @ApiOperation(value = " Set offload configuration on a namespace.")
+ @ApiOperation(value = "Set offload configuration on a namespace.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@@ -2452,6 +2621,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/removeOffloadPolicies")
@ApiOperation(value = " Set offload configuration on a namespace.")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist"),
@ApiResponse(code = 409, message = "Concurrent modification"),
@@ -2471,7 +2641,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/offloadPolicies")
- @ApiOperation(value = "Get offload configuration on a namespace.")
+ @ApiOperation(value = "Get offload configuration on a namespace.", response = OffloadPolicies.class)
@ApiResponses(value = {
@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist")})
@@ -2493,7 +2663,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/maxTopicsPerNamespace")
- @ApiOperation(value = "Get maxTopicsPerNamespace config on a namespace.")
+ @ApiOperation(value = "Get maxTopicsPerNamespace config on a namespace.", response = Integer.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace does not exist") })
public void getMaxTopicsPerNamespace(@Suspended final AsyncResponse asyncResponse,
@@ -2518,7 +2688,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/maxTopicsPerNamespace")
@ApiOperation(value = "Set maxTopicsPerNamespace config on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist"), })
public void setInactiveTopicPolicies(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
@@ -2530,8 +2702,10 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/maxTopicsPerNamespace")
- @ApiOperation(value = "Set maxTopicsPerNamespace config on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiOperation(value = "Remove maxTopicsPerNamespace config on a namespace.")
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist"), })
public void setInactiveTopicPolicies(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
@@ -2542,7 +2716,9 @@ public class Namespaces extends NamespacesBase {
@PUT
@Path("/{tenant}/{namespace}/property/{key}/{value}")
@ApiOperation(value = "Put a key value pair property on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist"), })
public void setProperty(
@Suspended final AsyncResponse asyncResponse,
@@ -2556,7 +2732,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/property/{key}")
- @ApiOperation(value = "Get property value for a given key on a namespace.")
+ @ApiOperation(value = "Get property value for a given key on a namespace.", response = String.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist"), })
public void getProperty(
@@ -2571,7 +2747,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/property/{key}")
@ApiOperation(value = "Remove property value for a given key on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist"), })
public void removeProperty(
@Suspended final AsyncResponse asyncResponse,
@@ -2585,7 +2763,9 @@ public class Namespaces extends NamespacesBase {
@PUT
@Path("/{tenant}/{namespace}/properties")
@ApiOperation(value = "Put key value pairs property on a namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist"), })
public void setProperties(
@Suspended final AsyncResponse asyncResponse,
@@ -2599,7 +2779,8 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/properties")
- @ApiOperation(value = "Get key value pair properties for a given namespace.")
+ @ApiOperation(value = "Get key value pair properties for a given namespace.",
+ response = String.class, responseContainer = "Map")
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist"), })
public void getProperties(
@@ -2613,7 +2794,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/properties")
@ApiOperation(value = "Clear properties on a given namespace.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or namespace doesn't exist"), })
public void clearProperties(
@Suspended final AsyncResponse asyncResponse,
@@ -2625,7 +2808,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/resourcegroup")
- @ApiOperation(value = "Get the resource group attached to the namespace")
+ @ApiOperation(value = "Get the resource group attached to the namespace", response = String.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist") })
public void getNamespaceResourceGroup(
@@ -2647,7 +2830,9 @@ public class Namespaces extends NamespacesBase {
@POST
@Path("/{tenant}/{namespace}/resourcegroup/{resourcegroup}")
@ApiOperation(value = "Set resourcegroup for a namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 412, message = "Invalid resourcegroup") })
public void setNamespaceResourceGroup(@PathParam("tenant") String tenant, @PathParam("namespace") String namespace,
@@ -2659,7 +2844,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/resourcegroup")
@ApiOperation(value = "Delete resourcegroup for a namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 412, message = "Invalid resourcegroup")})
public void removeNamespaceResourceGroup(@PathParam("tenant") String tenant,
@@ -2671,7 +2858,13 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/scanOffloadedLedgers")
@ApiOperation(value = "Trigger the scan of offloaded Ledgers on the LedgerOffloader for the given namespace")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Successful get of offloaded ledger data", response = String.class,
+ examples = @Example(value = { @ExampleProperty(mediaType = "application/json",
+ value = "{\"objects\":[{\"key1\":\"value1\",\"key2\":\"value2\"}],"
+ + "\"total\":100,\"errors\":5,\"unknown\":3}")
+ })),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace doesn't exist") })
public Response scanOffloadedLedgers(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace) {
@@ -2720,7 +2913,7 @@ public class Namespaces extends NamespacesBase {
@GET
@Path("/{tenant}/{namespace}/entryFilters")
- @ApiOperation(value = "Get maxConsumersPerSubscription config on a namespace.")
+ @ApiOperation(value = "Get maxConsumersPerSubscription config on a namespace.", response = EntryFilters.class)
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Namespace does not exist") })
public void getEntryFiltersPerTopic(
@@ -2743,6 +2936,7 @@ public class Namespaces extends NamespacesBase {
@Path("/{tenant}/{namespace}/entryFilters")
@ApiOperation(value = "Set entry filters for namespace")
@ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
@ApiResponse(code = 400, message = "Specified entry filters are not valid"),
@ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist")
@@ -2764,7 +2958,9 @@ public class Namespaces extends NamespacesBase {
@DELETE
@Path("/{tenant}/{namespace}/entryFilters")
@ApiOperation(value = "Remove entry filters for namespace")
- @ApiResponses(value = {@ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponses(value = {
+ @ApiResponse(code = 204, message = "Operation successful"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
@ApiResponse(code = 404, message = "Tenant or cluster or namespace doesn't exist"),
@ApiResponse(code = 412, message = "Invalid TTL")})
public void removeNamespaceEntryFilters(@Suspended AsyncResponse asyncResponse,
@@ -2780,7 +2976,5 @@ public class Namespaces extends NamespacesBase {
});
}
-
-
private static final Logger log = LoggerFactory.getLogger(Namespaces.class);
}