You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by pe...@apache.org on 2020/06/17 11:44:06 UTC
[pulsar] branch master updated: Update swagger file for 2.6.0.
(#7288)
This is an automated email from the ASF dual-hosted git repository.
penghui 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 d697226 Update swagger file for 2.6.0. (#7288)
d697226 is described below
commit d697226e864d0c0778ad5b7fa735916da1ead75e
Author: lipenghui <pe...@apache.org>
AuthorDate: Wed Jun 17 19:43:54 2020 +0800
Update swagger file for 2.6.0. (#7288)
---
site2/website/static/swagger/2.6.0/swagger.json | 11975 +++++++++++++++++++
.../static/swagger/2.6.0/swaggerfunctions.json | 1533 +++
.../website/static/swagger/2.6.0/swaggersink.json | 1067 ++
.../static/swagger/2.6.0/swaggersource.json | 1008 ++
4 files changed, 15583 insertions(+)
diff --git a/site2/website/static/swagger/2.6.0/swagger.json b/site2/website/static/swagger/2.6.0/swagger.json
new file mode 100644
index 0000000..67e637d
--- /dev/null
+++ b/site2/website/static/swagger/2.6.0/swagger.json
@@ -0,0 +1,11975 @@
+{
+ "swagger" : "2.0",
+ "info" : {
+ "description" : "This provides the REST API for admin operations",
+ "version" : "v2",
+ "title" : "Pulsar Admin REST API",
+ "license" : {
+ "name" : "Apache 2.0",
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
+ }
+ },
+ "basePath" : "/admin/v2",
+ "tags" : [ {
+ "name" : "bookies"
+ }, {
+ "name" : "broker-stats"
+ }, {
+ "name" : "brokers"
+ }, {
+ "name" : "clusters"
+ }, {
+ "name" : "namespaces"
+ }, {
+ "name" : "non-persistent topic"
+ }, {
+ "name" : "persistent topic"
+ }, {
+ "name" : "resource-quotas"
+ }, {
+ "name" : "schemas"
+ }, {
+ "name" : "tenants"
+ } ],
+ "schemes" : [ "http", "https" ],
+ "paths" : {
+ "/bookies/racks-info" : {
+ "get" : {
+ "tags" : [ "bookies" ],
+ "summary" : "Gets the rack placement information for all the bookies in the cluster",
+ "description" : "",
+ "operationId" : "getBookiesRackInfo",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/BookieInfo"
+ }
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/bookies/racks-info/{bookie}" : {
+ "get" : {
+ "tags" : [ "bookies" ],
+ "summary" : "Gets the rack placement information for a specific bookie in the cluster",
+ "description" : "",
+ "operationId" : "getBookieRackInfo",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "bookie",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/BookieInfo"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "bookies" ],
+ "summary" : "Updates the rack placement information for a specific bookie in the cluster",
+ "description" : "",
+ "operationId" : "updateBookieRackInfo",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "bookie",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "group",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "bookies" ],
+ "summary" : "Removed the rack placement information for a specific bookie in the cluster",
+ "description" : "",
+ "operationId" : "deleteBookieRackInfo",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "bookie",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/broker-stats/allocator-stats/{allocator}" : {
+ "get" : {
+ "tags" : [ "broker-stats" ],
+ "summary" : "Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'",
+ "description" : "",
+ "operationId" : "getAllocatorStats",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "allocator",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/AllocatorStats"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/broker-stats/bookieops" : {
+ "get" : {
+ "tags" : [ "broker-stats" ],
+ "summary" : "Get pending bookie client op stats by namesapce",
+ "description" : "",
+ "operationId" : "getPendingBookieOpsStats",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/PendingBookieOpsStats"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/broker-stats/broker-resource-availability/{tenant}/{namespace}" : {
+ "get" : {
+ "tags" : [ "broker-stats" ],
+ "summary" : "Broker availability report",
+ "description" : "This API gives the current broker availability in percent, each resource percentage usage is calculated and thensum of all of the resource usage percent is called broker-resource-availability<br/><br/>THIS API IS ONLY FOR USE BY TESTING FOR CONFIRMING NAMESPACE ALLOCATION ALGORITHM",
+ "operationId" : "getBrokerResourceAvailability",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/ResourceUnit"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "409" : {
+ "description" : "Load-manager doesn't support operation"
+ }
+ }
+ }
+ },
+ "/broker-stats/load-report" : {
+ "get" : {
+ "tags" : [ "broker-stats" ],
+ "summary" : "Get Load for this broker",
+ "description" : "consists of topics stats & systemResourceUsage",
+ "operationId" : "getLoadReport",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/LoadReport"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/broker-stats/mbeans" : {
+ "get" : {
+ "tags" : [ "broker-stats" ],
+ "summary" : "Get all the mbean details of this broker JVM",
+ "description" : "",
+ "operationId" : "getMBeans",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/Metrics"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/broker-stats/metrics" : {
+ "get" : {
+ "tags" : [ "broker-stats" ],
+ "summary" : "Gets the metrics for Monitoring",
+ "description" : "Requested should be executed by Monitoring agent on each broker to fetch the metrics",
+ "operationId" : "getMetrics",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/Metrics"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/broker-stats/topics" : {
+ "get" : {
+ "tags" : [ "broker-stats" ],
+ "summary" : "Get all the topic stats by namespace",
+ "description" : "",
+ "operationId" : "getTopics2",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/OutputStream"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/brokers/configuration" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Get all updatable dynamic configurations's name",
+ "description" : "",
+ "operationId" : "getDynamicConfigurationName",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/brokers/configuration/runtime" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Get all runtime configurations. This operation requires Pulsar super-user privileges.",
+ "description" : "",
+ "operationId" : "getRuntimeConfiguration",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/brokers/configuration/values" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Get value of all dynamic configurations' value overridden on local config",
+ "description" : "",
+ "operationId" : "getAllDynamicConfigurations",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object"
+ }
+ }
+ },
+ "404" : {
+ "description" : "Configuration not found"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/brokers/configuration/{configName}" : {
+ "delete" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Delete dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.",
+ "description" : "",
+ "operationId" : "deleteDynamicConfiguration",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "configName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Service configuration updated successfully"
+ },
+ "403" : {
+ "description" : "You don't have admin permission to update service-configuration"
+ },
+ "412" : {
+ "description" : "Invalid dynamic-config value"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/brokers/configuration/{configName}/{configValue}" : {
+ "post" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.",
+ "description" : "",
+ "operationId" : "updateDynamicConfiguration",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "configName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "configValue",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Service configuration updated successfully"
+ },
+ "403" : {
+ "description" : "You don't have admin permission to update service-configuration"
+ },
+ "404" : {
+ "description" : "Configuration not found"
+ },
+ "412" : {
+ "description" : "Invalid dynamic-config value"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/brokers/health" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Run a healthcheck against the broker",
+ "description" : "",
+ "operationId" : "healthcheck",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Everything is OK"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Cluster doesn't exist"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/brokers/internal-configuration" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Get the internal configuration data",
+ "description" : "",
+ "operationId" : "getInternalConfigurationData",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/InternalConfigurationData"
+ }
+ }
+ }
+ }
+ },
+ "/brokers/{clusterName}/{broker-webserviceurl}/ownedNamespaces" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Get the list of namespaces served by the specific broker",
+ "description" : "",
+ "operationId" : "getOwnedNamespaces",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "clusterName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "broker-webserviceurl",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/NamespaceOwnershipStatus"
+ }
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the cluster"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Cluster doesn't exist"
+ }
+ }
+ }
+ },
+ "/brokers/{cluster}" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid.",
+ "description" : "",
+ "operationId" : "getActiveBrokers",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve this cluster"
+ },
+ "401" : {
+ "description" : "Authentication required"
+ },
+ "403" : {
+ "description" : "This operation requires super-user access"
+ },
+ "404" : {
+ "description" : "Cluster does not exist: cluster={clustername}"
+ }
+ }
+ }
+ },
+ "/clusters" : {
+ "get" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Get the list of all the Pulsar clusters.",
+ "description" : "",
+ "operationId" : "getClusters",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Return a list of clusters.",
+ "schema" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ }
+ },
+ "/clusters/{cluster}" : {
+ "get" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Get the configuration for the specified cluster.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "getCluster",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Return the cluster data.",
+ "schema" : {
+ "$ref" : "#/definitions/ClusterData"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission."
+ },
+ "404" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Update the configuration for a cluster.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "updateCluster",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The cluster data",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/ClusterData"
+ },
+ "x-examples" : {
+ "application/json" : "{\n 'serviceUrl': 'http://pulsar.example.com:8080',\n 'brokerServiceUrl': 'pulsar://pulsar.example.com:6651'\n}"
+ }
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Cluster has been updated."
+ },
+ "403" : {
+ "description" : "Don't have admin permission or policies are read-only."
+ },
+ "404" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Create a new cluster.",
+ "description" : "This operation requires Pulsar superuser privileges, and the name cannot contain the '/' characters.",
+ "operationId" : "createCluster",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The cluster data",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/ClusterData"
+ },
+ "x-examples" : {
+ "application/json" : "{\n 'serviceUrl': 'http://pulsar.example.com:8080',\n 'brokerServiceUrl': 'pulsar://pulsar.example.com:6651',\n}"
+ }
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Cluster has been created."
+ },
+ "403" : {
+ "description" : "You don't have admin permission to create the cluster."
+ },
+ "409" : {
+ "description" : "Cluster already exists."
+ },
+ "412" : {
+ "description" : "Cluster name is not valid."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Delete an existing cluster.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "deleteCluster",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Cluster has been deleted."
+ },
+ "403" : {
+ "description" : "Don't have admin permission or policies are read-only."
+ },
+ "404" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "412" : {
+ "description" : "Cluster is not empty."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ }
+ },
+ "/clusters/{cluster}/failureDomains" : {
+ "get" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Get the cluster failure domains.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "getFailureDomains",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/FailureDomain"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/clusters/{cluster}/failureDomains/{domainName}" : {
+ "get" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Get a domain in a cluster",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "getDomain",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "domainName",
+ "in" : "path",
+ "description" : "The failure domain name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/FailureDomain"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "FailureDomain doesn't exist"
+ },
+ "412" : {
+ "description" : "Cluster doesn't exist"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Set the failure domain of the cluster.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "setFailureDomain",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "domainName",
+ "in" : "path",
+ "description" : "The failure domain name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The configuration data of a failure domain",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/FailureDomain"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission."
+ },
+ "404" : {
+ "description" : "Failure domain doesn't exist."
+ },
+ "409" : {
+ "description" : "Broker already exists in another domain."
+ },
+ "412" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Delete the failure domain of the cluster",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "deleteFailureDomain",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "domainName",
+ "in" : "path",
+ "description" : "The failure domain name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission or policy is read only"
+ },
+ "404" : {
+ "description" : "FailureDomain doesn't exist"
+ },
+ "412" : {
+ "description" : "Cluster doesn't exist"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/clusters/{cluster}/namespaceIsolationPolicies" : {
+ "get" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Get the namespace isolation policies assigned to the cluster.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "getNamespaceIsolationPolicies",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/NamespaceIsolationData"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission."
+ },
+ "404" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ }
+ },
+ "/clusters/{cluster}/namespaceIsolationPolicies/brokers" : {
+ "get" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Get list of brokers with namespace-isolation policies attached to them.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "getBrokersWithNamespaceIsolationPolicy",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "$ref" : "#/definitions/BrokerNamespaceIsolationData"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission."
+ },
+ "404" : {
+ "description" : "Namespace-isolation policies not found."
+ },
+ "412" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ }
+ },
+ "/clusters/{cluster}/namespaceIsolationPolicies/brokers/{broker}" : {
+ "get" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Get a broker with namespace-isolation policies attached to it.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "getBrokerWithNamespaceIsolationPolicy",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "broker",
+ "in" : "path",
+ "description" : "The broker name (<broker-hostname>:<web-service-port>)",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "broker1:8080"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/BrokerNamespaceIsolationData"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission."
+ },
+ "404" : {
+ "description" : "Namespace-isolation policies/ Broker not found."
+ },
+ "412" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ }
+ },
+ "/clusters/{cluster}/namespaceIsolationPolicies/{policyName}" : {
+ "get" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Get the single namespace isolation policy assigned to the cluster.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "getNamespaceIsolationPolicy",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "policyName",
+ "in" : "path",
+ "description" : "The name of the namespace isolation policy",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/NamespaceIsolationData"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission."
+ },
+ "404" : {
+ "description" : "Policy doesn't exist."
+ },
+ "412" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Set namespace isolation policy.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "setNamespaceIsolationPolicy",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "policyName",
+ "in" : "path",
+ "description" : "The namespace isolation policy name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The namespace isolation policy data",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/NamespaceIsolationData"
+ }
+ } ],
+ "responses" : {
+ "400" : {
+ "description" : "Namespace isolation policy data is invalid."
+ },
+ "403" : {
+ "description" : "Don't have admin permission or policies are read-only."
+ },
+ "404" : {
+ "description" : "Namespace isolation policy doesn't exist."
+ },
+ "412" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Delete namespace isolation policy.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "deleteNamespaceIsolationPolicy",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "policyName",
+ "in" : "path",
+ "description" : "The namespace isolation policy name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission or policies are read only."
+ },
+ "404" : {
+ "description" : "Namespace isolation policy doesn't exist."
+ },
+ "412" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ }
+ },
+ "/clusters/{cluster}/peers" : {
+ "get" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Get the peer-cluster data for the specified cluster.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "getPeerCluster",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission."
+ },
+ "404" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "clusters" ],
+ "summary" : "Update peer-cluster-list for a cluster.",
+ "description" : "This operation requires Pulsar superuser privileges.",
+ "operationId" : "setPeerClusterNames",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "description" : "The cluster name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The list of peer cluster names",
+ "required" : true,
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "x-examples" : {
+ "application/json" : "[\n 'cluster-a',\n 'cluster-b'\n]"
+ }
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Cluster has been updated."
+ },
+ "403" : {
+ "description" : "Don't have admin permission or policies are read-only."
+ },
+ "404" : {
+ "description" : "Cluster doesn't exist."
+ },
+ "412" : {
+ "description" : "Peer cluster doesn't exist."
+ },
+ "500" : {
+ "description" : "Internal server error."
+ }
+ }
+ }
+ },
+ "/namespaces/{cluster}/antiAffinity/{group}" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "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",
+ "description" : "",
+ "operationId" : "getAntiAffinityNamespaces",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "cluster",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "group",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "tenant",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "412" : {
+ "description" : "Cluster not exist/Anti-affinity group can't be empty."
+ }
+ }
+ }
+ },
+ "/namespaces/{property}/{namespace}/persistence/bookieAffinity" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the bookie-affinity-group from namespace-local policy.",
+ "description" : "",
+ "operationId" : "getBookieAffinityGroup",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "property",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/BookieAffinityGroupData"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete the bookie-affinity-group from namespace-local policy.",
+ "description" : "",
+ "operationId" : "deleteBookieAffinityGroup",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "property",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the list of all the namespaces for a certain tenant.",
+ "description" : "",
+ "operationId" : "getTenantNamespaces",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the dump all the policies specified for a namespace.",
+ "description" : "",
+ "operationId" : "getPolicies",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/Policies"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Creates a new namespace with the specified policies",
+ "description" : "",
+ "operationId" : "createNamespace",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Policies for the namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/Policies"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster doesn't exist"
+ },
+ "409" : {
+ "description" : "Namespace already exists"
+ },
+ "412" : {
+ "description" : "Namespace name is not valid"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete a namespace and all the topics under it.",
+ "description" : "",
+ "operationId" : "deleteNamespace",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Namespace is not empty"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/antiAffinity" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get anti-affinity group of a namespace.",
+ "description" : "",
+ "operationId" : "getNamespaceAntiAffinityGroup",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set anti-affinity group for a namespace",
+ "description" : "",
+ "operationId" : "setNamespaceAntiAffinityGroup",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Anti-affinity group for the specified namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "412" : {
+ "description" : "Invalid antiAffinityGroup"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove anti-affinity group of a namespace.",
+ "description" : "",
+ "operationId" : "removeNamespaceAntiAffinityGroup",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/autoSubscriptionCreation" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Override broker's allowAutoSubscriptionCreation setting for a namespace",
+ "description" : "",
+ "operationId" : "setAutoSubscriptionCreation",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Settings for automatic subscription creation",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/AutoSubscriptionCreationOverride"
+ }
+ } ],
+ "responses" : {
+ "400" : {
+ "description" : "Invalid autoSubscriptionCreation override"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove override of broker's allowAutoSubscriptionCreation in a namespace",
+ "description" : "",
+ "operationId" : "removeAutoSubscriptionCreation",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/autoTopicCreation" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Override broker's allowAutoTopicCreation setting for a namespace",
+ "description" : "",
+ "operationId" : "setAutoTopicCreation",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Settings for automatic topic creation",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/AutoTopicCreationOverride"
+ }
+ } ],
+ "responses" : {
+ "400" : {
+ "description" : "Invalid autoTopicCreation override"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "406" : {
+ "description" : "The number of partitions should be less than or equal to maxNumPartitionsPerPartitionedTopic"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove override of broker's allowAutoTopicCreation in a namespace",
+ "description" : "",
+ "operationId" : "removeAutoTopicCreation",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/backlogQuota" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set a backlog quota for all the topics on a namespace.",
+ "description" : "",
+ "operationId" : "setBacklogQuota",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "backlogQuotaType",
+ "in" : "query",
+ "required" : false,
+ "type" : "string",
+ "enum" : [ "destination_storage" ]
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Backlog quota for all topics of the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/BacklogQuota"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Specified backlog quota exceeds retention quota. Increase retention quota and retry request"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove a backlog quota policy from a namespace.",
+ "description" : "",
+ "operationId" : "removeBacklogQuota",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "backlogQuotaType",
+ "in" : "query",
+ "required" : false,
+ "type" : "string",
+ "enum" : [ "destination_storage" ]
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/backlogQuotaMap" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get backlog quota map on a namespace.",
+ "description" : "",
+ "operationId" : "getBacklogQuotaMap",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/bundles" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the bundles split data.",
+ "description" : "",
+ "operationId" : "getBundlesData",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/BundlesData"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "412" : {
+ "description" : "Namespace is not setup to split in bundles"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/clearBacklog" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Clear backlog for all topics on a namespace.",
+ "description" : "",
+ "operationId" : "clearNamespaceBacklog",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/clearBacklog/{subscription}" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Clear backlog for a given subscription on all topics on a namespace.",
+ "description" : "",
+ "operationId" : "clearNamespaceBacklogForSubscription",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subscription",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/compactionThreshold" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Maximum number of uncompacted bytes in topics before compaction is triggered.",
+ "description" : "The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction",
+ "operationId" : "getCompactionThreshold",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set maximum number of uncompacted bytes in a topic before compaction is triggered.",
+ "description" : "The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction",
+ "operationId" : "setCompactionThreshold",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Maximum number of uncompacted bytes in a topic of the specified namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "compactionThreshold value is not valid"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/deduplication" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Enable or disable broker side deduplication for all topics in a namespace",
+ "description" : "",
+ "operationId" : "modifyDeduplication",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Flag for disabling or enabling broker side deduplication for all topics in the specified namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/delayedDelivery" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get delayed delivery messages config on a namespace.",
+ "description" : "",
+ "operationId" : "getDelayedDeliveryPolicies",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/DelayedDeliveryPolicies"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set delayed delivery messages config on a namespace.",
+ "description" : "",
+ "operationId" : "setDelayedDeliveryPolicies",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Delayed delivery policies for the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/DelayedDeliveryPolicies"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/dispatchRate" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get dispatch-rate configured for the namespace, -1 represents not configured yet",
+ "description" : "",
+ "operationId" : "getDispatchRate",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/DispatchRate"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set dispatch-rate throttling for all topics of the namespace",
+ "description" : "",
+ "operationId" : "setDispatchRate",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Dispatch rate for all topics of the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/DispatchRate"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/encryptionRequired" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Message encryption is required or not for all topics in a namespace",
+ "description" : "",
+ "operationId" : "modifyEncryptionRequired",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Flag defining if message encryption is required",
+ "required" : true,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/isAllowAutoUpdateSchema" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "The flag of whether allow auto update schema",
+ "description" : "",
+ "operationId" : "getIsAllowAutoUpdateSchema",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "boolean"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Update flag of whether allow auto update schema",
+ "description" : "",
+ "operationId" : "setIsAllowAutoUpdateSchema",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Flag of whether to allow auto update schema",
+ "required" : true,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/maxConsumersPerSubscription" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get maxConsumersPerSubscription config on a namespace.",
+ "description" : "",
+ "operationId" : "getMaxConsumersPerSubscription",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set maxConsumersPerSubscription configuration on a namespace.",
+ "description" : "",
+ "operationId" : "setMaxConsumersPerSubscription",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Number of maximum consumers per subscription",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "maxConsumersPerSubscription value is not valid"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/maxConsumersPerTopic" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get maxConsumersPerTopic config on a namespace.",
+ "description" : "",
+ "operationId" : "getMaxConsumersPerTopic",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set maxConsumersPerTopic configuration on a namespace.",
+ "description" : "",
+ "operationId" : "setMaxConsumersPerTopic",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Number of maximum consumers per topic",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "maxConsumersPerTopic value is not valid"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/maxProducersPerTopic" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get maxProducersPerTopic config on a namespace.",
+ "description" : "",
+ "operationId" : "getMaxProducersPerTopic",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set maxProducersPerTopic configuration on a namespace.",
+ "description" : "",
+ "operationId" : "setMaxProducersPerTopic",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Number of maximum producers per topic",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "maxProducersPerTopic value is not valid"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumer" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get maxUnackedMessagesPerConsumer config on a namespace.",
+ "description" : "",
+ "operationId" : "getMaxUnackedMessagesPerConsumer",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set maxConsumersPerTopic configuration on a namespace.",
+ "description" : "",
+ "operationId" : "setMaxUnackedMessagesPerConsumer",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Number of maximum unacked messages per consumer",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "maxUnackedMessagesPerConsumer value is not valid"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscription" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get maxUnackedMessagesPerSubscription config on a namespace.",
+ "description" : "",
+ "operationId" : "getMaxUnackedmessagesPerSubscription",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set maxUnackedMessagesPerSubscription configuration on a namespace.",
+ "description" : "",
+ "operationId" : "setMaxUnackedMessagesPerSubscription",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Number of maximum unacked messages per subscription",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "maxUnackedMessagesPerSubscription value is not valid"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/messageTTL" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the message TTL for the namespace",
+ "description" : "",
+ "operationId" : "getNamespaceMessageTTL",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set message TTL in seconds for namespace",
+ "description" : "",
+ "operationId" : "setNamespaceMessageTTL",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "TTL in seconds for the specified namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "412" : {
+ "description" : "Invalid TTL"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/offloadDeletionLagMs" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper)",
+ "description" : "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.",
+ "operationId" : "getOffloadDeletionLag",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "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)",
+ "description" : "A negative value disables the deletion completely.",
+ "operationId" : "setOffloadDeletionLag",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "New number of milliseconds to wait before deleting a ledger segment which has been offloaded",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "offloadDeletionLagMs value is not valid"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Clear the namespace configured offload deletion lag. The topics in the namespace will fallback to using the default configured deletion lag for the broker",
+ "description" : "",
+ "operationId" : "clearOffloadDeletionLag",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/offloadPolicies" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get offload configuration on a namespace.",
+ "description" : "",
+ "operationId" : "getOffloadPolicies",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/OffloadPolicies"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set offload configuration on a namespace.",
+ "description" : "",
+ "operationId" : "setOffloadPolicies",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Offload policies for the specified namespace",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/OffloadPolicies"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "OffloadPolicies is empty or driver is not supported or bucket is not valid"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/offloadThreshold" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage",
+ "description" : "A negative value disables automatic offloading",
+ "operationId" : "getOffloadThreshold",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage",
+ "description" : "-1 will revert to using the cluster default. A negative value disables automatic offloading. ",
+ "operationId" : "setOffloadThreshold",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Maximum number of bytes stored on the pulsar cluster for a topic of the specified namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "offloadThreshold value is not valid"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/permissions" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Retrieve the permissions for a namespace.",
+ "description" : "",
+ "operationId" : "getPermissions",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Namespace is not empty"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/permissions/{role}" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Grant a new permission to a role on a namespace.",
+ "description" : "",
+ "operationId" : "grantPermissionOnNamespace",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "role",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "List of permissions for the specified role",
+ "required" : false,
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "produce", "consume", "functions" ]
+ }
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "501" : {
+ "description" : "Authorization is not enabled"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Revoke all permissions to a role on a namespace.",
+ "description" : "",
+ "operationId" : "revokePermissionsOnNamespace",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "role",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/persistence" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the persistence configuration for a namespace.",
+ "description" : "",
+ "operationId" : "getPersistence",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PersistencePolicies"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set the persistence configuration for all the topics on a namespace.",
+ "description" : "",
+ "operationId" : "setPersistence",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Persistence policies for the specified namespace",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/PersistencePolicies"
+ }
+ } ],
+ "responses" : {
+ "400" : {
+ "description" : "Invalid persistence policies"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/persistence/bookieAffinity" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set the bookie-affinity-group to namespace-persistent policy.",
+ "description" : "",
+ "operationId" : "setBookieAffinityGroup",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Bookie affinity group for the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/BookieAffinityGroupData"
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/replication" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the replication clusters for a namespace.",
+ "description" : "",
+ "operationId" : "getNamespaceReplicationClusters",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "412" : {
+ "description" : "Namespace is not global"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set the replication clusters for a namespace.",
+ "description" : "",
+ "operationId" : "setNamespaceReplicationClusters",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "List of replication clusters",
+ "required" : true,
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Peer-cluster can't be part of replication-cluster"
+ },
+ "412" : {
+ "description" : "Namespace is not global or invalid cluster ids"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/replicatorDispatchRate" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get replicator dispatch-rate configured for the namespace, -1 represents not configured yet",
+ "description" : "",
+ "operationId" : "getReplicatorDispatchRate",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/DispatchRate"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set replicator dispatch-rate throttling for all topics of the namespace",
+ "description" : "",
+ "operationId" : "setReplicatorDispatchRate",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Replicator dispatch rate for all topics of the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/DispatchRate"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/retention" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get retention config on a namespace.",
+ "description" : "",
+ "operationId" : "getRetention",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/RetentionPolicies"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set retention configuration on a namespace.",
+ "description" : "",
+ "operationId" : "setRetention",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Retention policies for the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/RetentionPolicies"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Retention Quota must exceed backlog quota"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema",
+ "description" : "The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api",
+ "operationId" : "getSchemaAutoUpdateCompatibilityStrategy",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "AutoUpdateDisabled", "Backward", "Forward", "Full", "AlwaysCompatible", "BackwardTransitive", "ForwardTransitive", "FullTransitive" ]
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Update the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema",
+ "description" : "The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api",
+ "operationId" : "setSchemaAutoUpdateCompatibilityStrategy",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Strategy used to check the compatibility of new schemas",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/schemaCompatibilityStrategy" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "The strategy of the namespace schema compatibility ",
+ "description" : "",
+ "operationId" : "getSchemaCompatibilityStrategy",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ]
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Update the strategy used to check the compatibility of new schema",
+ "description" : "",
+ "operationId" : "setSchemaCompatibilityStrategy",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Strategy used to check the compatibility of new schema",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/schemaValidationEnforced" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get schema validation enforced flag for namespace.",
+ "description" : "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.",
+ "operationId" : "getSchemaValidtionEnforced",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "boolean"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenants or Namespace doesn't exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set schema validation enforced flag on namespace.",
+ "description" : "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.",
+ "operationId" : "setSchemaValidtionEnforced",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Flag of whether validation is enforced on the specified namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or Namespace doesn't exist"
+ },
+ "412" : {
+ "description" : "schemaValidationEnforced value is not valid"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/subscribeRate" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get subscribe-rate configured for the namespace",
+ "description" : "",
+ "operationId" : "getSubscribeRate",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/SubscribeRate"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set subscribe-rate throttling for all topics of the namespace",
+ "description" : "",
+ "operationId" : "setSubscribeRate",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Subscribe rate for all topics of the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/SubscribeRate"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/subscriptionAuthMode" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set a subscription auth mode for all the topics on a namespace.",
+ "description" : "",
+ "operationId" : "setSubscriptionAuthMode",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Subscription auth mode for all topics of the specified namespace",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/subscriptionDispatchRate" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get Subscription dispatch-rate configured for the namespace, -1 represents not configured yet",
+ "description" : "",
+ "operationId" : "getSubscriptionDispatchRate",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/DispatchRate"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set Subscription dispatch-rate throttling for all topics of the namespace",
+ "description" : "",
+ "operationId" : "setSubscriptionDispatchRate",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Subscription dispatch rate for all topics of the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/DispatchRate"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/subscriptionExpirationTime" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the subscription expiration time for the namespace",
+ "description" : "",
+ "operationId" : "getSubscriptionExpirationTime",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set subscription expiration time in minutes for namespace",
+ "description" : "",
+ "operationId" : "setSubscriptionExpirationTime",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Expiration time in minutes for the specified namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "412" : {
+ "description" : "Invalid expiration time"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/topics" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the list of all the topics under a certain namespace.",
+ "description" : "",
+ "operationId" : "getTopics",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "mode",
+ "in" : "query",
+ "required" : false,
+ "type" : "string",
+ "default" : "PERSISTENT",
+ "enum" : [ "PERSISTENT", "NON_PERSISTENT", "ALL" ]
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/unload" : {
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Unload namespace",
+ "description" : "Unload an active namespace from the current broker serving it. Performing this operation will let the brokerremoves all producers, consumers, and connections using this namespace, and close all topics (includingtheir persistent store). During that operation, the namespace is marked as tentatively unavailable until thebroker completes the unloading action. This operation requires strictly super user privileges, since it wouldresult in non-persistent message loss a [...]
+ "operationId" : "unloadNamespace",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or namespace doesn't exist"
+ },
+ "412" : {
+ "description" : "Namespace is already unloaded or Namespace has bundles activated"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/unsubscribe/{subscription}" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Unsubscribes the given subscription on all topics on a namespace.",
+ "description" : "",
+ "operationId" : "unsubscribeNamespace",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subscription",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/{bundle}" : {
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete a namespace bundle and all the topics under it.",
+ "description" : "",
+ "operationId" : "deleteNamespaceBundle",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Namespace bundle is not empty"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Clear backlog for all topics on a namespace bundle.",
+ "description" : "",
+ "operationId" : "clearNamespaceBundleBacklog",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription}" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Clear backlog for a given subscription on all topics on a namespace bundle.",
+ "description" : "",
+ "operationId" : "clearNamespaceBundleBacklogForSubscription",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subscription",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/{bundle}/split" : {
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Split a namespace bundle",
+ "description" : "",
+ "operationId" : "splitNamespaceBundle",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "unload",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "splitAlgorithmName",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/{bundle}/unload" : {
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Unload a namespace bundle",
+ "description" : "",
+ "operationId" : "unloadNamespaceBundle",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription}" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Unsubscribes the given subscription on all topics on a namespace bundle.",
+ "description" : "",
+ "operationId" : "unsubscribeNamespaceBundle",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subscription",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get the list of non-persistent topics under a namespace.",
+ "description" : "",
+ "operationId" : "getList",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "401" : {
+ "description" : "Don't have permission to manage resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "The tenant/namespace does not exist"
+ },
+ "412" : {
+ "description" : "Namespace name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/partitioned" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get the list of partitioned topics under a namespace.",
+ "description" : "",
+ "operationId" : "getPartitionedTopicList",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "tenant/namespace/topic doesn't exit"
+ },
+ "412" : {
+ "description" : "Namespace name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{bundle}" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get the list of non-persistent topics under a namespace bundle.",
+ "description" : "",
+ "operationId" : "getListFromBundle",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "description" : "Bundle range of a topic",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "401" : {
+ "description" : "Don't have permission to manage resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "412" : {
+ "description" : "Namespace name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}" : {
+ "put" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Create a non-partitioned topic.",
+ "description" : "This is the only REST endpoint from which non-partitioned topics could be created.",
+ "operationId" : "createNonPartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "409" : {
+ "description" : "Partitioned topic already exist"
+ },
+ "412" : {
+ "description" : "Failed Reason : Name is invalid or Namespace does not have any clusters configured"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Delete a topic.",
+ "description" : "The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.",
+ "operationId" : "deleteTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "force",
+ "in" : "query",
+ "description" : "Stop all producer/consumer/replicator and delete topic forcefully",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic has active producers/subscriptions"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Expiry messages on all subscriptions of topic.",
+ "description" : "",
+ "operationId" : "expireMessagesForAllSubscriptions",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "expireTimeInSeconds",
+ "in" : "path",
+ "description" : "Expires beyond the specified number of seconds",
+ "required" : true,
+ "type" : "integer",
+ "default" : 0,
+ "format" : "int32"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic or subscription does not exist"
+ },
+ "405" : {
+ "description" : "Expiry messages on a non-persistent topic is not allowed"
+ },
+ "412" : {
+ "description" : "Can't find owner for topic"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/backlog" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get estimated backlog for offline topic.",
+ "description" : "",
+ "operationId" : "getBacklog",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PersistentOfflineTopicStats"
+ }
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/compaction" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get the status of a compaction operation for a topic.",
+ "description" : "",
+ "operationId" : "compactionStatus",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/LongRunningProcessStatus"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist, or compaction hasn't run"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Trigger a compaction operation on a topic.",
+ "description" : "",
+ "operationId" : "compact",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "409" : {
+ "description" : "Compaction already running"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/createMissedPartitions" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Create missed partitions of an existing partitioned topic.",
+ "description" : "",
+ "operationId" : "createMissedPartitions",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to adminisActions to be grantedtrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant does not exist"
+ },
+ "409" : {
+ "description" : "Partitioned topic does not exist"
+ },
+ "412" : {
+ "description" : "Partitioned topic name is invalid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/internal-info" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get the stored topic metadata.",
+ "description" : "",
+ "operationId" : "getManagedLedgerInfo",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/internalStats" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get the internal stats for the topic.",
+ "description" : "",
+ "operationId" : "getInternalStats",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PersistentTopicInternalStats"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to manage resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "The tenant/namespace/topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/lastMessageId" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Return the last commit message id of topic",
+ "description" : "",
+ "operationId" : "getLastMessageId",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get message by its messageId.",
+ "description" : "",
+ "operationId" : "getMessageById",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "ledgerId",
+ "in" : "path",
+ "description" : "The ledger id",
+ "required" : true,
+ "type" : "integer",
+ "format" : "int64"
+ }, {
+ "name" : "entryId",
+ "in" : "path",
+ "description" : "The entry id",
+ "required" : true,
+ "type" : "integer",
+ "format" : "int64"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic, subscription or the message position does not exist"
+ },
+ "405" : {
+ "description" : "Skipping messages on a non-persistent topic is not allowed"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/offload" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Offload a prefix of a topic to long term storage",
+ "description" : "",
+ "operationId" : "offloadStatus",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/OffloadProcessStatus"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Offload a prefix of a topic to long term storage",
+ "description" : "",
+ "operationId" : "triggerOffload",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "409" : {
+ "description" : "Offload already running"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/partitioned-stats" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get the stats for the partitioned topic.",
+ "description" : "",
+ "operationId" : "getPartitionedStats",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "perPartition",
+ "in" : "query",
+ "description" : "Get per partition stats",
+ "required" : false,
+ "type" : "boolean",
+ "default" : true
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "getPreciseBacklog",
+ "in" : "query",
+ "description" : "Is return precise backlog or imprecise backlog",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Partitioned topic name is invalid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/partitions" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get partitioned topic metadata.",
+ "description" : "",
+ "operationId" : "getPartitionedMetadata",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "checkAllowAutoCreation",
+ "in" : "query",
+ "description" : "Is check configuration required to automatically create topic",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PartitionedTopicMetadata"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to manage resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "The tenant/namespace/topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate cluster configuration"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Increment partitions of an existing partitioned topic.",
+ "description" : "It only increments partitions of existing non-global partitioned-topic",
+ "operationId" : "updatePartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "updateLocalTopicOnly",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The number of partitions for the topic",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32",
+ "default" : 0
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to adminisActions to be grantedtrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant does not exist"
+ },
+ "406" : {
+ "description" : "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic"
+ },
+ "409" : {
+ "description" : "Partitioned topic does not exist"
+ },
+ "412" : {
+ "description" : "Partitioned topic name is invalid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Create a partitioned topic.",
+ "description" : "It needs to be called before creating a producer on a partitioned topic.",
+ "operationId" : "createPartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The number of partitions for the topic",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32",
+ "default" : 0
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to manage resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "The tenant/namespace does not exist"
+ },
+ "406" : {
+ "description" : "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic"
+ },
+ "409" : {
+ "description" : "Partitioned topic already exists"
+ },
+ "412" : {
+ "description" : "Failed Reason : Name is invalid or Namespace does not have any clusters configured"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Delete a partitioned topic.",
+ "description" : "It will also delete all the partitions of the topic if it exists.",
+ "operationId" : "deletePartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "force",
+ "in" : "query",
+ "description" : "Stop all producer/consumer/replicator and delete topic forcefully",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Partitioned topic does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Partitioned topic name is invalid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/permissions" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get permissions on a topic.",
+ "description" : "Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.",
+ "operationId" : "getPermissionsOnTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object"
+ }
+ }
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "tenant/namespace/topic doesn't exit"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/permissions/{role}" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Grant a new permission to a role on a single topic.",
+ "description" : "",
+ "operationId" : "grantPermissionsOnTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "role",
+ "in" : "path",
+ "description" : "Client role to which grant permissions",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Actions to be granted (produce,functions,consume)",
+ "required" : false,
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "produce", "consume", "functions" ]
+ }
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "tenant/namespace/topic doesn't exit"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Revoke permissions on a topic.",
+ "description" : "Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).",
+ "operationId" : "revokePermissionsOnTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "role",
+ "in" : "path",
+ "description" : "Client role to which grant permissions",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "tenant/namespace/topic doesn't exit"
+ },
+ "412" : {
+ "description" : "Permissions are not set at the topic level"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/stats" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get the stats for the topic.",
+ "description" : "",
+ "operationId" : "getStats",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "getPreciseBacklog",
+ "in" : "query",
+ "description" : "Is return precise backlog or imprecise backlog",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/NonPersistentTopicStats"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to manage resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "The tenant/namespace/topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}" : {
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Delete a subscription.",
+ "description" : "The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.",
+ "operationId" : "deleteSubscription",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscription to be deleted",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "force",
+ "in" : "query",
+ "description" : "Disconnect and close all consumers and delete subscription forcefully",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Subscription has active consumers"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Expiry messages on a topic subscription.",
+ "description" : "",
+ "operationId" : "expireTopicMessages",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscription to be Expiry messages on",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "expireTimeInSeconds",
+ "in" : "path",
+ "description" : "Expires beyond the specified number of seconds",
+ "required" : true,
+ "type" : "integer",
+ "default" : 0,
+ "format" : "int32"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic or subscription does not exist"
+ },
+ "405" : {
+ "description" : "Expiry messages on a non-persistent topic is not allowed"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Peek nth message on a topic subscription.",
+ "description" : "",
+ "operationId" : "peekNthMessage",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscribed message expired",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "messagePosition",
+ "in" : "path",
+ "description" : "The number of messages (default 1)",
+ "required" : true,
+ "type" : "integer",
+ "default" : 1,
+ "format" : "int32"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic, subscription or the message position does not exist"
+ },
+ "405" : {
+ "description" : "Skipping messages on a non-persistent topic is not allowed"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Reset subscription to message position closest to given position.",
+ "description" : "It fence cursor and disconnects all active consumers before reseting cursor.",
+ "operationId" : "resetCursorOnPosition",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscription to reset position on",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "messageId",
+ "description" : "messageId to reset back to (ledgerId:entryId)",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/MessageIdImpl"
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic/Subscription does not exist"
+ },
+ "405" : {
+ "description" : "Not supported for partitioned topics"
+ },
+ "412" : {
+ "description" : "Unable to find position for position specified"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Reset subscription to message position closest to absolute timestamp (in ms).",
+ "description" : "It fence cursor and disconnects all active consumers before reseting cursor.",
+ "operationId" : "resetCursor",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscription to reset position on",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "timestamp",
+ "in" : "path",
+ "description" : "time in minutes to reset back to (or minutes, hours,days,weeks eg:100m, 3h, 2d, 5w)",
+ "required" : true,
+ "type" : "integer",
+ "format" : "int64"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic/Subscription does not exist"
+ },
+ "405" : {
+ "description" : "Method Not Allowed"
+ },
+ "412" : {
+ "description" : "Failed to reset cursor on subscription or Unable to find position for timestamp specified"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Skipping messages on a topic subscription.",
+ "description" : "",
+ "operationId" : "skipMessages",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Name of subscription",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "numMessages",
+ "in" : "path",
+ "description" : "The number of messages to skip",
+ "required" : true,
+ "type" : "integer",
+ "default" : 0,
+ "format" : "int32"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic or subscription does not exist"
+ },
+ "405" : {
+ "description" : "Skipping messages on a partitioned topic is not allowed"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Skip all messages on a topic subscription.",
+ "description" : "Completely clears the backlog on the subscription.",
+ "operationId" : "skipAllMessages",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Name of subscription",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic or subscription does not exist"
+ },
+ "405" : {
+ "description" : "Operation not allowed on non-persistent topic"
+ },
+ "412" : {
+ "description" : "Can't find owner for topic"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}" : {
+ "put" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Create a subscription on the topic.",
+ "description" : "Creates a subscription on the topic at the specified message id",
+ "operationId" : "createSubscription",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subscriptionName",
+ "in" : "path",
+ "description" : "Subscription to create position on",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "messageId",
+ "description" : "messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/MessageIdImpl"
+ }
+ }, {
+ "name" : "replicated",
+ "in" : "query",
+ "description" : "Is replicated required to perform this operation",
+ "required" : false,
+ "type" : "boolean"
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic/Subscription does not exist"
+ },
+ "405" : {
+ "description" : "Not supported for partitioned topics"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/subscriptions" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get the list of persistent subscriptions for a given topic.",
+ "description" : "",
+ "operationId" : "getSubscriptions",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/terminate" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog",
+ "description" : "",
+ "operationId" : "terminate",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/MessageId"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Termination of a partitioned topic is not allowed"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/terminate/partitions" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Terminate all partitioned topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog",
+ "description" : "",
+ "operationId" : "terminatePartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Termination of a partitioned topic is not allowed"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/unload" : {
+ "put" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Unload a topic",
+ "description" : "",
+ "operationId" : "unloadTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "This operation requires super-user access"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "The tenant/namespace/topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get the list of topics under a namespace.",
+ "description" : "",
+ "operationId" : "getList",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "tenant/namespace/topic doesn't exit"
+ },
+ "412" : {
+ "description" : "Namespace name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/partitioned" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get the list of partitioned topics under a namespace.",
+ "description" : "",
+ "operationId" : "getPartitionedTopicList",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "tenant/namespace/topic doesn't exit"
+ },
+ "412" : {
+ "description" : "Namespace name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}" : {
+ "put" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Create a non-partitioned topic.",
+ "description" : "This is the only REST endpoint from which non-partitioned topics could be created.",
+ "operationId" : "createNonPartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "409" : {
+ "description" : "Partitioned topic already exist"
+ },
+ "412" : {
+ "description" : "Failed Reason : Name is invalid or Namespace does not have any clusters configured"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Delete a topic.",
+ "description" : "The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.",
+ "operationId" : "deleteTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "force",
+ "in" : "query",
+ "description" : "Stop all producer/consumer/replicator and delete topic forcefully",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic has active producers/subscriptions"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Expiry messages on all subscriptions of topic.",
+ "description" : "",
+ "operationId" : "expireMessagesForAllSubscriptions",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "expireTimeInSeconds",
+ "in" : "path",
+ "description" : "Expires beyond the specified number of seconds",
+ "required" : true,
+ "type" : "integer",
+ "default" : 0,
+ "format" : "int32"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic or subscription does not exist"
+ },
+ "405" : {
+ "description" : "Expiry messages on a non-persistent topic is not allowed"
+ },
+ "412" : {
+ "description" : "Can't find owner for topic"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/backlog" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get estimated backlog for offline topic.",
+ "description" : "",
+ "operationId" : "getBacklog",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PersistentOfflineTopicStats"
+ }
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/compaction" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get the status of a compaction operation for a topic.",
+ "description" : "",
+ "operationId" : "compactionStatus",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/LongRunningProcessStatus"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist, or compaction hasn't run"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Trigger a compaction operation on a topic.",
+ "description" : "",
+ "operationId" : "compact",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "409" : {
+ "description" : "Compaction already running"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/createMissedPartitions" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Create missed partitions of an existing partitioned topic.",
+ "description" : "",
+ "operationId" : "createMissedPartitions",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to adminisActions to be grantedtrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant does not exist"
+ },
+ "409" : {
+ "description" : "Partitioned topic does not exist"
+ },
+ "412" : {
+ "description" : "Partitioned topic name is invalid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/internal-info" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get the stored topic metadata.",
+ "description" : "",
+ "operationId" : "getManagedLedgerInfo",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/internalStats" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get the internal stats for the topic.",
+ "description" : "",
+ "operationId" : "getInternalStats",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PersistentTopicInternalStats"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/lastMessageId" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Return the last commit message id of topic",
+ "description" : "",
+ "operationId" : "getLastMessageId",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get message by its messageId.",
+ "description" : "",
+ "operationId" : "getMessageById",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "ledgerId",
+ "in" : "path",
+ "description" : "The ledger id",
+ "required" : true,
+ "type" : "integer",
+ "format" : "int64"
+ }, {
+ "name" : "entryId",
+ "in" : "path",
+ "description" : "The entry id",
+ "required" : true,
+ "type" : "integer",
+ "format" : "int64"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic, subscription or the message position does not exist"
+ },
+ "405" : {
+ "description" : "Skipping messages on a non-persistent topic is not allowed"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/offload" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Offload a prefix of a topic to long term storage",
+ "description" : "",
+ "operationId" : "offloadStatus",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/OffloadProcessStatus"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Offload a prefix of a topic to long term storage",
+ "description" : "",
+ "operationId" : "triggerOffload",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Operation is not allowed on the persistent topic"
+ },
+ "409" : {
+ "description" : "Offload already running"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/partitioned-stats" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get the stats for the partitioned topic.",
+ "description" : "",
+ "operationId" : "getPartitionedStats",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "perPartition",
+ "in" : "query",
+ "description" : "Get per partition stats",
+ "required" : false,
+ "type" : "boolean",
+ "default" : true
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "getPreciseBacklog",
+ "in" : "query",
+ "description" : "Is return precise backlog or imprecise backlog",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Partitioned topic name is invalid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/partitions" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get partitioned topic metadata.",
+ "description" : "",
+ "operationId" : "getPartitionedMetadata",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "checkAllowAutoCreation",
+ "in" : "query",
+ "description" : "Is check configuration required to automatically create topic",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PartitionedTopicMetadata"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Partitioned topic name is invalid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Increment partitions of an existing partitioned topic.",
+ "description" : "It only increments partitions of existing non-global partitioned-topic",
+ "operationId" : "updatePartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "updateLocalTopicOnly",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The number of partitions for the topic",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32",
+ "default" : 0
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to adminisActions to be grantedtrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant does not exist"
+ },
+ "406" : {
+ "description" : "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic"
+ },
+ "409" : {
+ "description" : "Partitioned topic does not exist"
+ },
+ "412" : {
+ "description" : "Partitioned topic name is invalid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Create a partitioned topic.",
+ "description" : "It needs to be called before creating a producer on a partitioned topic.",
+ "operationId" : "createPartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The number of partitions for the topic",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32",
+ "default" : 0
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant does not exist"
+ },
+ "406" : {
+ "description" : "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic"
+ },
+ "409" : {
+ "description" : "Partitioned topic already exist"
+ },
+ "412" : {
+ "description" : "Failed Reason : Name is invalid or Namespace does not have any clusters configured"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Delete a partitioned topic.",
+ "description" : "It will also delete all the partitions of the topic if it exists.",
+ "operationId" : "deletePartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "force",
+ "in" : "query",
+ "description" : "Stop all producer/consumer/replicator and delete topic forcefully",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Partitioned topic does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Partitioned topic name is invalid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/permissions" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get permissions on a topic.",
+ "description" : "Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.",
+ "operationId" : "getPermissionsOnTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object"
+ }
+ }
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "tenant/namespace/topic doesn't exit"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/permissions/{role}" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Grant a new permission to a role on a single topic.",
+ "description" : "",
+ "operationId" : "grantPermissionsOnTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "role",
+ "in" : "path",
+ "description" : "Client role to which grant permissions",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Actions to be granted (produce,functions,consume)",
+ "required" : false,
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "produce", "consume", "functions" ]
+ }
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "tenant/namespace/topic doesn't exit"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Revoke permissions on a topic.",
+ "description" : "Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).",
+ "operationId" : "revokePermissionsOnTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "role",
+ "in" : "path",
+ "description" : "Client role to which grant permissions",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "tenant/namespace/topic doesn't exit"
+ },
+ "412" : {
+ "description" : "Permissions are not set at the topic level"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/stats" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get the stats for the topic.",
+ "description" : "",
+ "operationId" : "getStats",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "getPreciseBacklog",
+ "in" : "query",
+ "description" : "Is return precise backlog or imprecise backlog",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/TopicStats"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}" : {
+ "delete" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Delete a subscription.",
+ "description" : "The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.",
+ "operationId" : "deleteSubscription",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscription to be deleted",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "force",
+ "in" : "query",
+ "description" : "Disconnect and close all consumers and delete subscription forcefully",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Subscription has active consumers"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Expiry messages on a topic subscription.",
+ "description" : "",
+ "operationId" : "expireTopicMessages",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscription to be Expiry messages on",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "expireTimeInSeconds",
+ "in" : "path",
+ "description" : "Expires beyond the specified number of seconds",
+ "required" : true,
+ "type" : "integer",
+ "default" : 0,
+ "format" : "int32"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic or subscription does not exist"
+ },
+ "405" : {
+ "description" : "Expiry messages on a non-persistent topic is not allowed"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Peek nth message on a topic subscription.",
+ "description" : "",
+ "operationId" : "peekNthMessage",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscribed message expired",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "messagePosition",
+ "in" : "path",
+ "description" : "The number of messages (default 1)",
+ "required" : true,
+ "type" : "integer",
+ "default" : 1,
+ "format" : "int32"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic, subscription or the message position does not exist"
+ },
+ "405" : {
+ "description" : "Skipping messages on a non-persistent topic is not allowed"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Reset subscription to message position closest to given position.",
+ "description" : "It fence cursor and disconnects all active consumers before reseting cursor.",
+ "operationId" : "resetCursorOnPosition",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscription to reset position on",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "messageId",
+ "description" : "messageId to reset back to (ledgerId:entryId)",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/MessageIdImpl"
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic/Subscription does not exist"
+ },
+ "405" : {
+ "description" : "Not supported for partitioned topics"
+ },
+ "412" : {
+ "description" : "Unable to find position for position specified"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Reset subscription to message position closest to absolute timestamp (in ms).",
+ "description" : "It fence cursor and disconnects all active consumers before reseting cursor.",
+ "operationId" : "resetCursor",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Subscription to reset position on",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "timestamp",
+ "in" : "path",
+ "description" : "time in minutes to reset back to (or minutes, hours,days,weeks eg:100m, 3h, 2d, 5w)",
+ "required" : true,
+ "type" : "integer",
+ "format" : "int64"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic/Subscription does not exist"
+ },
+ "405" : {
+ "description" : "Method Not Allowed"
+ },
+ "412" : {
+ "description" : "Failed to reset cursor on subscription or Unable to find position for timestamp specified"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Skipping messages on a topic subscription.",
+ "description" : "",
+ "operationId" : "skipMessages",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Name of subscription",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "numMessages",
+ "in" : "path",
+ "description" : "The number of messages to skip",
+ "required" : true,
+ "type" : "integer",
+ "default" : 0,
+ "format" : "int32"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic or subscription does not exist"
+ },
+ "405" : {
+ "description" : "Skipping messages on a partitioned topic is not allowed"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Skip all messages on a topic subscription.",
+ "description" : "Completely clears the backlog on the subscription.",
+ "operationId" : "skipAllMessages",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subName",
+ "in" : "path",
+ "description" : "Name of subscription",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic or subscription does not exist"
+ },
+ "405" : {
+ "description" : "Operation not allowed on non-persistent topic"
+ },
+ "412" : {
+ "description" : "Can't find owner for topic"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}" : {
+ "put" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Create a subscription on the topic.",
+ "description" : "Creates a subscription on the topic at the specified message id",
+ "operationId" : "createSubscription",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "subscriptionName",
+ "in" : "path",
+ "description" : "Subscription to create position on",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "messageId",
+ "description" : "messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/MessageIdImpl"
+ }
+ }, {
+ "name" : "replicated",
+ "in" : "query",
+ "description" : "Is replicated required to perform this operation",
+ "required" : false,
+ "type" : "boolean"
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic/Subscription does not exist"
+ },
+ "405" : {
+ "description" : "Not supported for partitioned topics"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/subscriptions" : {
+ "get" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Get the list of persistent subscriptions for a given topic.",
+ "description" : "",
+ "operationId" : "getSubscriptions",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/terminate" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog",
+ "description" : "",
+ "operationId" : "terminate",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/MessageId"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Termination of a partitioned topic is not allowed"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/terminate/partitions" : {
+ "post" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Terminate all partitioned topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog",
+ "description" : "",
+ "operationId" : "terminatePartitionedTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Termination of a partitioned topic is not allowed"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/persistent/{tenant}/{namespace}/{topic}/unload" : {
+ "put" : {
+ "tags" : [ "persistent topic" ],
+ "summary" : "Unload a topic",
+ "description" : "",
+ "operationId" : "unloadTopic",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Specify the tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Specify the namespace",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "description" : "Specify topic name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "401" : {
+ "description" : "Don't have permission to administrate resources on this tenant"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Topic name is not valid or can't find owner for topic"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ },
+ "503" : {
+ "description" : "Failed to validate global cluster configuration"
+ }
+ }
+ }
+ },
+ "/resource-quotas" : {
+ "get" : {
+ "tags" : [ "resource-quotas" ],
+ "summary" : "Get the default quota",
+ "description" : "",
+ "operationId" : "getDefaultResourceQuota",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "resource-quotas" ],
+ "summary" : "Set the default quota",
+ "description" : "",
+ "operationId" : "setDefaultResourceQuota",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Default resource quota",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/ResourceQuota"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/resource-quotas/{tenant}/{namespace}/{bundle}" : {
+ "get" : {
+ "tags" : [ "resource-quotas" ],
+ "summary" : "Get resource quota of a namespace bundle.",
+ "description" : "",
+ "operationId" : "getNamespaceBundleResourceQuota",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Tenant name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Namespace name within the specified tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "description" : "Namespace bundle range",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ResourceQuota"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "resource-quotas" ],
+ "summary" : "Set resource quota on a namespace.",
+ "description" : "",
+ "operationId" : "setNamespaceBundleResourceQuota",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Tenant name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Namespace name within the specified tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "description" : "Namespace bundle range",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Resource quota for the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/ResourceQuota"
+ }
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "resource-quotas" ],
+ "summary" : "Remove resource quota for a namespace.",
+ "description" : "",
+ "operationId" : "removeNamespaceBundleResourceQuota",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "Tenant name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "description" : "Namespace name within the specified tenant",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bundle",
+ "in" : "path",
+ "description" : "Namespace bundle range",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/schemas/{tenant}/{namespace}/{topic}/compatibility" : {
+ "post" : {
+ "tags" : [ "schemas" ],
+ "summary" : "test the schema compatibility",
+ "description" : "",
+ "operationId" : "testCompatibility",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "A JSON value presenting a schema playload. An example of the expected schema can be found down here.",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/PostSchemaPayload"
+ },
+ "x-examples" : {
+ "application/json" : "{\"type\": \"STRING\", \"schema\": \"\", \"properties\": { \"key1\" : \"value1\" + } }"
+ }
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/IsCompatibilityResponse"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Client is not authorized or Don't have admin permission"
+ },
+ "403" : {
+ "description" : "Client is not authenticated"
+ },
+ "404" : {
+ "description" : "Tenant or Namespace or Topic doesn't exist"
+ },
+ "412" : {
+ "description" : "Failed to find the ownership for the topic"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ }
+ },
+ "/schemas/{tenant}/{namespace}/{topic}/schema" : {
+ "get" : {
+ "tags" : [ "schemas" ],
+ "summary" : "Get the schema of a topic",
+ "description" : "",
+ "operationId" : "getSchema",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/GetSchemaResponse"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Client is not authorized or Don't have admin permission"
+ },
+ "403" : {
+ "description" : "Client is not authenticated"
+ },
+ "404" : {
+ "description" : "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic"
+ },
+ "412" : {
+ "description" : "Failed to find the ownership for the topic"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "schemas" ],
+ "summary" : "Update the schema of a topic",
+ "description" : "",
+ "operationId" : "postSchema",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "A JSON value presenting a schema playload. An example of the expected schema can be found down here.",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/PostSchemaPayload"
+ },
+ "x-examples" : {
+ "application/json" : "{\"type\": \"STRING\", \"schema\": \"\", \"properties\": { \"key1\" : \"value1\" + } }"
+ }
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PostSchemaResponse"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Client is not authorized or Don't have admin permission"
+ },
+ "403" : {
+ "description" : "Client is not authenticated"
+ },
+ "404" : {
+ "description" : "Tenant or Namespace or Topic doesn't exist"
+ },
+ "409" : {
+ "description" : "Incompatible schema"
+ },
+ "412" : {
+ "description" : "Failed to find the ownership for the topic"
+ },
+ "422" : {
+ "description" : "Invalid schema data"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "schemas" ],
+ "summary" : "Delete the schema of a topic",
+ "description" : "",
+ "operationId" : "deleteSchema",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/DeleteSchemaResponse"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Client is not authorized or Don't have admin permission"
+ },
+ "403" : {
+ "description" : "Client is not authenticated"
+ },
+ "404" : {
+ "description" : "Tenant or Namespace or Topic doesn't exist"
+ },
+ "412" : {
+ "description" : "Failed to find the ownership for the topic"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ }
+ },
+ "/schemas/{tenant}/{namespace}/{topic}/schema/{version}" : {
+ "get" : {
+ "tags" : [ "schemas" ],
+ "summary" : "Get the schema of a topic at a given version",
+ "description" : "",
+ "operationId" : "getSchema",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "version",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/GetSchemaResponse"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Client is not authorized or Don't have admin permission"
+ },
+ "403" : {
+ "description" : "Client is not authenticated"
+ },
+ "404" : {
+ "description" : "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic"
+ },
+ "412" : {
+ "description" : "Failed to find the ownership for the topic"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ }
+ },
+ "/schemas/{tenant}/{namespace}/{topic}/schemas" : {
+ "get" : {
+ "tags" : [ "schemas" ],
+ "summary" : "Get the all schemas of a topic",
+ "description" : "",
+ "operationId" : "getAllSchemas",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/GetAllVersionsSchemaResponse"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Client is not authorized or Don't have admin permission"
+ },
+ "403" : {
+ "description" : "Client is not authenticated"
+ },
+ "404" : {
+ "description" : "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic"
+ },
+ "412" : {
+ "description" : "Failed to find the ownership for the topic"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ }
+ },
+ "/schemas/{tenant}/{namespace}/{topic}/version" : {
+ "post" : {
+ "tags" : [ "schemas" ],
+ "summary" : "get the version of the schema",
+ "description" : "",
+ "operationId" : "getVersionBySchema",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "topic",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "A JSON value presenting a schema playload. An example of the expected schema can be found down here.",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/PostSchemaPayload"
+ },
+ "x-examples" : {
+ "application/json" : "{\"type\": \"STRING\", \"schema\": \"\", \"properties\": { \"key1\" : \"value1\" + } }"
+ }
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/LongSchemaVersion"
+ }
+ },
+ "307" : {
+ "description" : "Current broker doesn't serve the namespace of this topic"
+ },
+ "401" : {
+ "description" : "Client is not authorized or Don't have admin permission"
+ },
+ "403" : {
+ "description" : "Client is not authenticated"
+ },
+ "404" : {
+ "description" : "Tenant or Namespace or Topic doesn't exist"
+ },
+ "412" : {
+ "description" : "Failed to find the ownership for the topic"
+ },
+ "422" : {
+ "description" : "Invalid schema data"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ }
+ },
+ "/tenants" : {
+ "get" : {
+ "tags" : [ "tenants" ],
+ "summary" : "Get the list of existing tenants.",
+ "description" : "",
+ "operationId" : "getTenants",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "403" : {
+ "description" : "The requester doesn't have admin permissions"
+ },
+ "404" : {
+ "description" : "Tenant doesn't exist"
+ }
+ }
+ }
+ },
+ "/tenants/{tenant}" : {
+ "get" : {
+ "tags" : [ "tenants" ],
+ "summary" : "Get the admin configuration for a given tenant.",
+ "description" : "",
+ "operationId" : "getTenantAdmin",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "The tenant name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/TenantInfo"
+ }
+ },
+ "403" : {
+ "description" : "The requester doesn't have admin permissions"
+ },
+ "404" : {
+ "description" : "Tenant does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "tenants" ],
+ "summary" : "Update the admins for a tenant.",
+ "description" : "This operation requires Pulsar super-user privileges.",
+ "operationId" : "updateTenant",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "The tenant name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "TenantInfo",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/TenantInfo"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "The requester doesn't have admin permissions"
+ },
+ "404" : {
+ "description" : "Tenant does not exist"
+ },
+ "409" : {
+ "description" : "Tenant already exists"
+ },
+ "412" : {
+ "description" : "Clusters do not exist"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "tenants" ],
+ "summary" : "Create a new tenant.",
+ "description" : "This operation requires Pulsar super-user privileges.",
+ "operationId" : "createTenant",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "The tenant name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "TenantInfo",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/TenantInfo"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "The requester doesn't have admin permissions"
+ },
+ "409" : {
+ "description" : "Tenant already exists"
+ },
+ "412" : {
+ "description" : "Clusters do not exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "tenants" ],
+ "summary" : "Delete a tenant and all namespaces and topics under it.",
+ "description" : "",
+ "operationId" : "deleteTenant",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "description" : "The tenant name",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "The requester doesn't have admin permissions"
+ },
+ "404" : {
+ "description" : "Tenant does not exist"
+ },
+ "409" : {
+ "description" : "The tenant still has active namespaces"
+ }
+ }
+ }
+ }
+ },
+ "definitions" : {
+ "AllocatorStats" : {
+ "type" : "object",
+ "properties" : {
+ "numDirectArenas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "numHeapArenas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "numThreadLocalCaches" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "normalCacheSize" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "smallCacheSize" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "tinyCacheSize" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "directArenas" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/PoolArenaStats"
+ }
+ },
+ "heapArenas" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/PoolArenaStats"
+ }
+ }
+ }
+ },
+ "AuthPolicies" : {
+ "type" : "object",
+ "properties" : {
+ "namespace_auth" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string",
+ "enum" : [ "produce", "consume", "functions" ]
+ }
+ }
+ },
+ "destination_auth" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string",
+ "enum" : [ "produce", "consume", "functions" ]
+ }
+ }
+ }
+ },
+ "subscription_auth_roles" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ },
+ "AutoFailoverPolicyData" : {
+ "type" : "object",
+ "properties" : {
+ "policy_type" : {
+ "type" : "string",
+ "description" : "The auto failover policy type",
+ "enum" : [ "min_available" ]
+ },
+ "parameters" : {
+ "type" : "object",
+ "example" : "{\n \"min_limit\": 3,\n \"usage_threshold\": 80\n}\n",
+ "description" : "The parameters applied to the auto failover policy specified by `policy_type`.\nThe parameters for 'min_available' are :\n - 'min_limit': the limit of minimal number of available brokers in primary group before auto failover\n - 'usage_threshold': the resource usage threshold. If the usage of a broker is beyond this value, it would be marked as unavailable\n",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "The auto failover policy configuration data"
+ },
+ "AutoSubscriptionCreationOverride" : {
+ "type" : "object",
+ "properties" : {
+ "allowAutoSubscriptionCreation" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "AutoTopicCreationOverride" : {
+ "type" : "object",
+ "properties" : {
+ "allowAutoTopicCreation" : {
+ "type" : "boolean"
+ },
+ "topicType" : {
+ "type" : "string"
+ },
+ "defaultNumPartitions" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
... 5627 lines suppressed ...