You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ur...@apache.org on 2022/05/07 08:43:48 UTC
[pulsar-site] branch main updated (73724c1b44 -> cb824c7d6f)
This is an automated email from the ASF dual-hosted git repository.
urfree pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
from 73724c1b44 fix: build all languages
new e174ec9ee4 sync website from pulsar
new 3736462dd6 sync website swagger files from pulsar
new cb824c7d6f feat: only build en and zh-CN
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
site2/website-next/docusaurus.config.js | 2 +-
site2/website/data/resources.js | 22 +
site2/website/package.json | 3 +-
site2/website/pages/en/contact.js | 16 +-
site2/website/pages/en/download.js | 10 +-
site2/website/pages/en/index.js | 1 -
site2/website/pages/en/resources.js | 20 +
site2/website/scripts/replace.js | 6 +-
site2/website/siteConfig.js | 79 +-
.../static/swagger/2.10.0}/swagger.json | 6971 +++++++++++++-------
.../static/swagger/2.10.0}/swaggerfunctions.json | 750 +--
.../static/swagger/2.10.0}/swaggerpackages.json | 692 +-
.../static/swagger/2.10.0}/swaggersink.json | 637 +-
.../static/swagger/2.10.0}/swaggersource.json | 701 +-
.../static/swagger/{2.8.2 => 2.8.3}/swagger.json | 1190 ++--
.../static/swagger/2.8.3}/swaggerfunctions.json | 587 +-
.../static/swagger/2.8.3}/swaggerpackages.json | 500 +-
.../static/swagger/2.8.3}/swaggersink.json | 491 +-
.../static/swagger/2.8.3}/swaggersource.json | 500 +-
.../static/swagger/2.9.2}/swagger.json | 1719 ++---
.../static/swagger/2.9.2}/swaggerfunctions.json | 794 +--
.../static/swagger/2.9.2}/swaggerpackages.json | 594 +-
.../static/swagger/2.9.2}/swaggersink.json | 688 +-
.../static/swagger/2.9.2}/swaggersource.json | 688 +-
.../versioned_docs/version-2.5.1/standalone.md | 230 -
25 files changed, 9834 insertions(+), 8057 deletions(-)
copy site2/{website-next/static/swagger/2.9.0 => website/static/swagger/2.10.0}/swagger.json (91%)
copy site2/{website-next/static/swagger/2.8.2 => website/static/swagger/2.10.0}/swaggerfunctions.json (92%)
copy site2/{website-next/static/swagger/2.8.2 => website/static/swagger/2.10.0}/swaggerpackages.json (94%)
copy site2/{website-next/static/swagger/2.8.1 => website/static/swagger/2.10.0}/swaggersink.json (92%)
copy site2/{website-next/static/swagger/2.9.1 => website/static/swagger/2.10.0}/swaggersource.json (93%)
copy site2/website/static/swagger/{2.8.2 => 2.8.3}/swagger.json (99%)
copy site2/{website-next/static/swagger/2.9.1 => website/static/swagger/2.8.3}/swaggerfunctions.json (99%)
copy site2/{website-next/static/swagger/2.8.2 => website/static/swagger/2.8.3}/swaggerpackages.json (99%)
copy site2/{website-next/static/swagger/2.9.1 => website/static/swagger/2.8.3}/swaggersink.json (99%)
copy site2/{website-next/static/swagger/2.8.2 => website/static/swagger/2.8.3}/swaggersource.json (99%)
copy site2/{website-next/static/swagger/2.9.1 => website/static/swagger/2.9.2}/swagger.json (99%)
copy site2/{website-next/static/swagger/2.9.1 => website/static/swagger/2.9.2}/swaggerfunctions.json (99%)
copy site2/{website-next/static/swagger/2.8.2 => website/static/swagger/2.9.2}/swaggerpackages.json (99%)
copy site2/{website-next/static/swagger/2.9.1 => website/static/swagger/2.9.2}/swaggersink.json (99%)
copy site2/{website-next/static/swagger/2.9.1 => website/static/swagger/2.9.2}/swaggersource.json (99%)
delete mode 100644 site2/website/versioned_docs/version-2.5.1/standalone.md
[pulsar-site] 02/03: sync website swagger files from pulsar
Posted by ur...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
commit 3736462dd65f1a516770bb2b10a4a8bb5968a5bd
Author: Li Li <ur...@apache.org>
AuthorDate: Sat May 7 16:38:14 2022 +0800
sync website swagger files from pulsar
---
site2/website/static/swagger/2.10.0/swagger.json | 25683 +++++++++++++++++++
.../static/swagger/2.10.0/swaggerfunctions.json | 2977 +++
.../static/swagger/2.10.0/swaggerpackages.json | 1649 ++
.../website/static/swagger/2.10.0/swaggersink.json | 2351 ++
.../static/swagger/2.10.0/swaggersource.json | 2305 ++
site2/website/static/swagger/2.8.3/swagger.json | 23429 +++++++++++++++++
.../static/swagger/2.8.3/swaggerfunctions.json | 3081 +++
.../static/swagger/2.8.3/swaggerpackages.json | 1743 ++
.../website/static/swagger/2.8.3/swaggersink.json | 2460 ++
.../static/swagger/2.8.3/swaggersource.json | 2420 ++
site2/website/static/swagger/2.9.2/swagger.json | 23947 +++++++++++++++++
.../static/swagger/2.9.2/swaggerfunctions.json | 3092 +++
.../static/swagger/2.9.2/swaggerpackages.json | 1743 ++
.../website/static/swagger/2.9.2/swaggersink.json | 2463 ++
.../static/swagger/2.9.2/swaggersource.json | 2420 ++
15 files changed, 101763 insertions(+)
diff --git a/site2/website/static/swagger/2.10.0/swagger.json b/site2/website/static/swagger/2.10.0/swagger.json
new file mode 100644
index 0000000000..f7d44cacb0
--- /dev/null
+++ b/site2/website/static/swagger/2.10.0/swagger.json
@@ -0,0 +1,25683 @@
+{
+ "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" : "resourcegroups"
+ }, {
+ "name" : "schemas"
+ }, {
+ "name" : "tenants"
+ } ],
+ "schemes" : [ "http", "https" ],
+ "paths" : {
+ "/bookies/all" : {
+ "get" : {
+ "tags" : [ "bookies" ],
+ "summary" : "Gets raw information for all the bookies in the cluster",
+ "description" : "",
+ "operationId" : "getAllBookies",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/BookiesClusterInfo"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/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 (note. bookie address format:`address:port`)",
+ "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/backlog-quota-check" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "An REST endpoint to trigger backlogQuotaCheck",
+ "description" : "",
+ "operationId" : "backlogQuotaCheck",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Everything is OK"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/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" : "string"
+ }
+ }
+ },
+ "403" : {
+ "description" : "You don't have admin permission to get configuration"
+ }
+ }
+ }
+ },
+ "/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" : "string"
+ }
+ }
+ },
+ "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" : "string"
+ }
+ }
+ },
+ "403" : {
+ "description" : "You don't have admin permission to view configuration"
+ },
+ "404" : {
+ "description" : "Configuration not found"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/brokers/configuration/{configName}" : {
+ "delete" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Delete dynamic ServiceConfiguration into metadata 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" ],
+ "parameters" : [ {
+ "name" : "topicVersion",
+ "in" : "query",
+ "required" : false,
+ "type" : "string",
+ "enum" : [ "V1", "V2" ]
+ } ],
+ "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"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ }
+ },
+ "/brokers/leaderBroker" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Get the information of the leader broker.",
+ "description" : "",
+ "operationId" : "getLeaderBroker",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/BrokerInfo"
+ }
+ },
+ "401" : {
+ "description" : "Authentication required"
+ },
+ "403" : {
+ "description" : "This operation requires super-user access"
+ },
+ "404" : {
+ "description" : "Leader broker not found"
+ }
+ }
+ }
+ },
+ "/brokers/ready" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Check if the broker is fully initialized",
+ "description" : "",
+ "operationId" : "isReady",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Broker is ready"
+ },
+ "500" : {
+ "description" : "Broker is not ready"
+ }
+ }
+ }
+ },
+ "/brokers/shutdown" : {
+ "post" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Shutdown broker gracefully.",
+ "description" : "",
+ "operationId" : "shutDownBrokerGracefully",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "maxConcurrentUnloadPerSec",
+ "in" : "query",
+ "description" : "if the value absent(value=0) means no concurrent limitation.",
+ "required" : false,
+ "type" : "integer",
+ "format" : "int32"
+ }, {
+ "name" : "forcedTerminateTopic",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : true
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Execute shutdown command successfully"
+ },
+ "403" : {
+ "description" : "You don't have admin permission to update service-configuration"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/brokers/version" : {
+ "get" : {
+ "tags" : [ "brokers" ],
+ "summary" : "Get version of current broker",
+ "description" : "",
+ "operationId" : "version",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Everything is OK",
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/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" : "string"
+ }
+ }
+ },
+ "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" : "force",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "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"
+ },
+ "405" : {
+ "description" : "Broker doesn't allow forced deletion of namespaces"
+ },
+ "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" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get autoSubscriptionCreation info in a namespace",
+ "description" : "",
+ "operationId" : "getAutoSubscriptionCreation",
+ "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/AutoSubscriptionCreationOverride"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or namespace doesn't exist"
+ }
+ }
+ },
+ "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" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get autoTopicCreation info in a namespace",
+ "description" : "",
+ "operationId" : "getAutoTopicCreation",
+ "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/AutoTopicCreationOverride"
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or namespace doesn't exist"
+ }
+ }
+ },
+ "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", "message_age" ]
+ }, {
+ "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", "message_age" ]
+ } ],
+ "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" : {
+ "$ref" : "#/definitions/BacklogQuota"
+ }
+ }
+ },
+ "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 or operate permission on the namespace"
+ },
+ "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 or operate permission on the namespace"
+ },
+ "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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete 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" : "deleteCompactionThreshold",
+ "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}/deduplication" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get broker side deduplication for all topics in a namespace",
+ "description" : "",
+ "operationId" : "getDeduplication",
+ "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" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove broker side deduplication for all topics in a namespace",
+ "description" : "",
+ "operationId" : "removeDeduplication",
+ "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}/deduplicationSnapshotInterval" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get deduplicationSnapshotInterval config on a namespace.",
+ "description" : "",
+ "operationId" : "getDeduplicationSnapshotInterval",
+ "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 deduplicationSnapshotInterval config on a namespace.",
+ "description" : "",
+ "operationId" : "setDeduplicationSnapshotInterval",
+ "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" : "Interval to take deduplication snapshot per topic",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace does not 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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete delayed delivery messages config on a namespace.",
+ "description" : "",
+ "operationId" : "removeDelayedDeliveryPolicies",
+ "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}/dispatchRate" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get dispatch-rate configured for the namespace, null means dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet",
+ "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/DispatchRateImpl"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete dispatch-rate throttling for all topics of the namespace",
+ "description" : "",
+ "operationId" : "deleteDispatchRate",
+ "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"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/encryptionRequired" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get message encryption required status in a namespace",
+ "description" : "",
+ "operationId" : "getEncryptionRequired",
+ "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" : "Tenant or namespace doesn't exist"
+ }
+ }
+ },
+ "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}/inactiveTopicPolicies" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get inactive topic policies config on a namespace.",
+ "description" : "",
+ "operationId" : "getInactiveTopicPolicies",
+ "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/InactiveTopicPolicies"
+ }
+ },
+ "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 inactive topic policies config on a namespace.",
+ "description" : "",
+ "operationId" : "setInactiveTopicPolicies",
+ "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" : "Inactive topic policies for the specified namespace",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/InactiveTopicPolicies"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove inactive topic policies from a namespace.",
+ "description" : "",
+ "operationId" : "removeInactiveTopicPolicies",
+ "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}/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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set maxConsumersPerSubscription configuration on a namespace.",
+ "description" : "",
+ "operationId" : "removeMaxConsumersPerSubscription",
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove maxConsumersPerTopic configuration on a namespace.",
+ "description" : "",
+ "operationId" : "removeMaxConsumersPerTopic",
+ "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}/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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove maxProducersPerTopic configuration on a namespace.",
+ "description" : "",
+ "operationId" : "removeMaxProducersPerTopic",
+ "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}/maxSubscriptionsPerTopic" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get maxSubscriptionsPerTopic config on a namespace.",
+ "description" : "",
+ "operationId" : "getMaxSubscriptionsPerTopic",
+ "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 maxSubscriptionsPerTopic configuration on a namespace.",
+ "description" : "",
+ "operationId" : "setMaxSubscriptionsPerTopic",
+ "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 subscriptions 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" : "maxUnackedMessagesPerSubscription value is not valid"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove maxSubscriptionsPerTopic configuration on a namespace.",
+ "description" : "",
+ "operationId" : "removeMaxSubscriptionsPerTopic",
+ "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}/maxTopicsPerNamespace" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get maxTopicsPerNamespace config on a namespace.",
+ "description" : "",
+ "operationId" : "getMaxTopicsPerNamespace",
+ "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 namespace does not exist"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set maxTopicsPerNamespace config on a namespace.",
+ "description" : "",
+ "operationId" : "setInactiveTopicPolicies",
+ "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 topics for specific namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or namespace doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set maxTopicsPerNamespace config on a namespace.",
+ "description" : "",
+ "operationId" : "setInactiveTopicPolicies",
+ "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 namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove maxUnackedMessagesPerConsumer config on a namespace.",
+ "description" : "",
+ "operationId" : "removeMaxUnackedmessagesPerConsumer",
+ "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"
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove maxUnackedMessagesPerSubscription config on a namespace.",
+ "description" : "",
+ "operationId" : "removeMaxUnackedmessagesPerSubscription",
+ "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"
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set message TTL in seconds for namespace",
+ "description" : "",
+ "operationId" : "removeNamespaceMessageTTL",
+ "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"
+ },
+ "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/OffloadPoliciesImpl"
+ }
+ },
+ "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/OffloadPoliciesImpl"
+ }
+ } ],
+ "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" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string",
+ "enum" : [ "produce", "consume", "functions", "sources", "sinks", "packages" ]
+ }
+ }
+ }
+ },
+ "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/subscription" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Retrieve the permissions for a subscription.",
+ "description" : "",
+ "operationId" : "getPermissionOnSubscription",
+ "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" : "array",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "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", "sources", "sinks", "packages" ]
+ }
+ }
+ } ],
+ "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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete the persistence configuration for all topics on a namespace",
+ "description" : "",
+ "operationId" : "deletePersistence",
+ "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"
+ }
+ }
+ }
+ },
+ "/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}/properties" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get key value pair properties for a given namespace.",
+ "description" : "",
+ "operationId" : "getProperties",
+ "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 namespace doesn't exist"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Put key value pairs property on a namespace.",
+ "description" : "",
+ "operationId" : "setProperties",
+ "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" : "Key value pair properties for the namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or namespace doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get property value for a given key on a namespace.",
+ "description" : "",
+ "operationId" : "clearProperties",
+ "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 namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/property/{key}" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get property value for a given key on a namespace.",
+ "description" : "",
+ "operationId" : "getProperty",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "key",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or namespace doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get property value for a given key on a namespace.",
+ "description" : "",
+ "operationId" : "removeProperty",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "key",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/property/{key}/{value}" : {
+ "put" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Put a key value pair property on a namespace.",
+ "description" : "",
+ "operationId" : "setProperty",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "key",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "value",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or namespace doesn't exist"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/removeOffloadPolicies" : {
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Set offload configuration on a namespace.",
+ "description" : "",
+ "operationId" : "removeOffloadPolicies",
+ "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"
+ },
+ "412" : {
+ "description" : "OffloadPolicies is empty or driver is not supported or bucket is not valid"
+ }
+ }
+ }
+ },
+ "/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, null means replicator dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate 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/DispatchRateImpl"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove replicator dispatch-rate throttling for all topics of the namespace",
+ "description" : "",
+ "operationId" : "removeReplicatorDispatchRate",
+ "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"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/resourcegroup" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get the resourcegroup attached to the namespace",
+ "description" : "",
+ "operationId" : "getNamespaceResourceGroup",
+ "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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete resourcegroup for a namespace",
+ "description" : "",
+ "operationId" : "removeNamespaceResourceGroup",
+ "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"
+ },
+ "412" : {
+ "description" : "Invalid resourcegroup"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/resourcegroup/{resourcegroup}" : {
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Set resourcegroup for a namespace",
+ "description" : "",
+ "operationId" : "setNamespaceResourceGroup",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tenant",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "namespace",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "resourcegroup",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace doesn't exist"
+ },
+ "412" : {
+ "description" : "Invalid resourcegroup"
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Remove retention configuration on a namespace.",
+ "description" : "",
+ "operationId" : "removeRetention",
+ "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"
+ }, {
+ "name" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete subscribe-rate throttling for all topics of the namespace",
+ "description" : "",
+ "operationId" : "deleteSubscribeRate",
+ "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"
+ }
+ }
+ }
+ },
+ "/namespaces/{tenant}/{namespace}/subscriptionAuthMode" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Get subscription auth mode in a namespace",
+ "description" : "",
+ "operationId" : "getSubscriptionAuthMode",
+ "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" : [ "None", "Prefix" ]
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or namespace doesn't exist"
+ }
+ }
+ },
+ "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, null means subscription dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate 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/DispatchRateImpl"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Delete Subscription dispatch-rate throttling for all topics of the namespace",
+ "description" : "",
+ "operationId" : "deleteSubscriptionDispatchRate",
+ "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"
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Remove subscription expiration time for namespace",
+ "description" : "",
+ "operationId" : "removeSubscriptionExpirationTime",
+ "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}/subscriptionTypesEnabled" : {
+ "get" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "The set of whether allow subscription types",
+ "description" : "",
+ "operationId" : "getSubscriptionTypesEnabled",
+ "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",
+ "uniqueItems" : true,
+ "items" : {
+ "type" : "string",
+ "enum" : [ "Exclusive", "Shared", "Failover", "Key_Shared" ]
+ }
+ }
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "namespaces" ],
+ "summary" : "Update set of whether allow share sub type",
+ "description" : "",
+ "operationId" : "setSubscriptionTypesEnabled",
+ "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" : "Set of whether allow subscription types",
+ "required" : true,
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "Exclusive", "Shared", "Failover", "Key_Shared" ]
+ }
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Namespace doesn't exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "namespaces" ],
+ "summary" : " Remove subscription types enabled on a namespace.",
+ "description" : "",
+ "operationId" : "removeSubscriptionTypesEnabled",
+ "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 Namespace does not exist"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/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 or operate permission on the namespace"
+ },
+ "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 or operate permission on the namespacen"
+ },
+ "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" : "force",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "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 or operate permission on the namespace"
+ },
+ "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 or operate permission on the namespace"
+ },
+ "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 or operate permission on the namespace"
+ },
+ "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"
+ }, {
+ "name" : "bundle",
+ "in" : "query",
+ "description" : "Specify the bundle name",
+ "required" : false,
+ "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 or operate permission on the namespace"
+ },
+ "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
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Key value pair properties for the topic metadata",
+ "required" : false,
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "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"
+ },
+ "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
+ }, {
+ "name" : "deleteSchema",
+ "in" : "query",
+ "description" : "Delete the topic's schema storage",
+ "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}/backlogQuota" : {
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set a backlog quota for a topic.",
+ "description" : "",
+ "operationId" : "setBacklogQuota",
+ "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",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "backlogQuotaType",
+ "in" : "query",
+ "required" : false,
+ "type" : "string",
+ "enum" : [ "destination_storage", "message_age" ]
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Specified backlog quota exceeds retention quota. Increase retention quota and retry request"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove a backlog quota policy from a topic.",
+ "description" : "",
+ "operationId" : "removeBacklogQuota",
+ "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" : "backlogQuotaType",
+ "in" : "query",
+ "required" : false,
+ "type" : "string",
+ "enum" : [ "destination_storage", "message_age" ]
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/backlogQuotaMap" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get backlog quota map on a topic.",
+ "description" : "",
+ "operationId" : "getBacklogQuotaMap",
+ "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" : "applied",
+ "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
+ }, {
+ "name" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic policy does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/backlogSize" : {
+ "put" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Calculate backlog size by a message ID (in bytes).",
+ "description" : "",
+ "operationId" : "getBacklogSizeByMessageId",
+ "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" : {
+ "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}/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}/compactionThreshold" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get compaction threshold configuration for specified topic.",
+ "description" : "",
+ "operationId" : "getCompactionThreshold",
+ "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" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, please enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set compaction threshold configuration for specified topic.",
+ "description" : "",
+ "operationId" : "setCompactionThreshold",
+ "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",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Dispatch rate for the specified topic",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, please enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove compaction threshold configuration for specified topic.",
+ "description" : "",
+ "operationId" : "removeCompactionThreshold",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, please enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/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 administrate 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}/deduplicationEnabled" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get deduplication configuration of a topic.",
+ "description" : "",
+ "operationId" : "getDeduplication",
+ "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" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set deduplication enabled on a topic.",
+ "description" : "",
+ "operationId" : "setDeduplication",
+ "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" : "isGlobal",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "DeduplicationEnabled policies for the specified topic",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove deduplication configuration for specified topic.",
+ "description" : "",
+ "operationId" : "removeDeduplication",
+ "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" : "isGlobal",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get deduplicationSnapshotInterval config on a topic.",
+ "description" : "",
+ "operationId" : "getDeduplicationSnapshotInterval",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set deduplicationSnapshotInterval config on a topic.",
+ "description" : "",
+ "operationId" : "setDeduplicationSnapshotInterval",
+ "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" : "Interval to take deduplication snapshot for the specified topic",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Delete deduplicationSnapshotInterval config on a topic.",
+ "description" : "",
+ "operationId" : "deleteDeduplicationSnapshotInterval",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/delayedDelivery" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get delayed delivery messages config on a topic.",
+ "description" : "",
+ "operationId" : "getDelayedDeliveryPolicies",
+ "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" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "applied",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set delayed delivery messages config on a topic.",
+ "description" : "",
+ "operationId" : "setDelayedDeliveryPolicies",
+ "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" : "isGlobal",
+ "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" : "Delayed delivery policies for the specified topic",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/DelayedDeliveryPolicies"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set delayed delivery messages config on a topic.",
+ "description" : "",
+ "operationId" : "deleteDelayedDeliveryPolicies",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/dispatchRate" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get dispatch rate configuration for specified topic.",
+ "description" : "",
+ "operationId" : "getDispatchRate",
+ "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" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, please enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set message dispatch rate configuration for specified topic.",
+ "description" : "",
+ "operationId" : "setDispatchRate",
+ "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",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Dispatch rate for the specified topic",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/DispatchRateImpl"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, please enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove message dispatch rate configuration for specified topic.",
+ "description" : "",
+ "operationId" : "removeDispatchRate",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, please enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/examinemessage" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Examine a specific message on a topic by position relative to the earliest or the latest message.",
+ "description" : "",
+ "operationId" : "examineMessage",
+ "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" : "initialPosition",
+ "in" : "query",
+ "description" : "Relative start position to examine message.It can be 'latest' or 'earliest'",
+ "required" : false,
+ "type" : "string",
+ "default" : "latest",
+ "enum" : [ "latest", "earliest" ]
+ }, {
+ "name" : "messagePosition",
+ "in" : "query",
+ "description" : "The position of messages (default 1)",
+ "required" : false,
+ "type" : "integer",
+ "default" : 1,
+ "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"
+ },
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic, the message position does not exist"
+ },
+ "405" : {
+ "description" : "If given partitioned topic"
+ },
+ "412" : {
+ "description" : "Topic name is not valid"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get inactive topic policies on a topic.",
+ "description" : "",
+ "operationId" : "getInactiveTopicPolicies",
+ "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" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set inactive topic policies on a topic.",
+ "description" : "",
+ "operationId" : "setInactiveTopicPolicies",
+ "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",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "inactive topic policies for the specified topic",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/InactiveTopicPolicies"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Delete inactive topic policies on a topic.",
+ "description" : "",
+ "operationId" : "deleteInactiveTopicPolicies",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ }
+ },
+ "/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
+ }, {
+ "name" : "metadata",
+ "in" : "query",
+ "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}/maxConsumers" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get maxConsumers config for specified topic.",
+ "description" : "",
+ "operationId" : "getMaxConsumers",
+ "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" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "applied",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set maxConsumers config for specified topic.",
+ "description" : "",
+ "operationId" : "setMaxConsumers",
+ "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" : "isGlobal",
+ "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 max consumers of the topic",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Invalid value of maxConsumers"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove maxConsumers config for specified topic.",
+ "description" : "",
+ "operationId" : "removeMaxConsumers",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get max consumers per subscription configuration for specified topic.",
+ "description" : "",
+ "operationId" : "getMaxConsumersPerSubscription",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, please enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set max consumers per subscription configuration for specified topic.",
+ "description" : "",
+ "operationId" : "setMaxConsumersPerSubscription",
+ "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" : "isGlobal",
+ "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" : "Dispatch rate for the specified topic",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, please enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove max consumers per subscription configuration for specified topic.",
+ "description" : "",
+ "operationId" : "removeMaxConsumersPerSubscription",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, please enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/maxMessageSize" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get maxMessageSize config for specified topic.",
+ "description" : "",
+ "operationId" : "getMaxMessageSize",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set maxMessageSize config for specified topic.",
+ "description" : "",
+ "operationId" : "setMaxMessageSize",
+ "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" : "isGlobal",
+ "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 max message size of the topic",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Invalid value of maxConsumers"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove maxMessageSize config for specified topic.",
+ "description" : "",
+ "operationId" : "removeMaxMessageSize",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/maxProducers" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get maxProducers config for specified topic.",
+ "description" : "",
+ "operationId" : "getMaxProducers",
+ "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" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set maxProducers config for specified topic.",
+ "description" : "",
+ "operationId" : "setMaxProducers",
+ "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",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "The max producers of the topic",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Invalid value of maxProducers"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove maxProducers config for specified topic.",
+ "description" : "",
+ "operationId" : "removeMaxProducers",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get maxSubscriptionsPerTopic config for specified topic.",
+ "description" : "",
+ "operationId" : "getMaxSubscriptionsPerTopic",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set maxSubscriptionsPerTopic config for specified topic.",
+ "description" : "",
+ "operationId" : "setMaxSubscriptionsPerTopic",
+ "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" : "isGlobal",
+ "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 max subscriptions of the topic",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ },
+ "412" : {
+ "description" : "Invalid value of maxSubscriptionsPerTopic"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove maxSubscriptionsPerTopic config for specified topic.",
+ "description" : "",
+ "operationId" : "removeMaxSubscriptionsPerTopic",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, to enable the topic level policy and retry"
+ },
+ "409" : {
+ "description" : "Concurrent modification"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get max unacked messages per consumer config on a topic.",
+ "description" : "",
+ "operationId" : "getMaxUnackedMessagesOnConsumer",
+ "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" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set max unacked messages per consumer config on a topic.",
+ "description" : "",
+ "operationId" : "setMaxUnackedMessagesOnConsumer",
+ "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" : "isGlobal",
+ "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" : "Max unacked messages on consumer policies for the specified topic",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Delete max unacked messages per consumer config on a topic.",
+ "description" : "",
+ "operationId" : "deleteMaxUnackedMessagesOnConsumer",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get max unacked messages per subscription config on a topic.",
+ "description" : "",
+ "operationId" : "getMaxUnackedMessagesOnSubscription",
+ "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" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set max unacked messages per subscription config on a topic.",
+ "description" : "",
+ "operationId" : "setMaxUnackedMessagesOnSubscription",
+ "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" : "isGlobal",
+ "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" : "Max unacked messages on subscription policies for the specified topic",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Delete max unacked messages per subscription config on a topic.",
+ "description" : "",
+ "operationId" : "deleteMaxUnackedMessagesOnSubscription",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/messageTTL" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get message TTL in seconds for a topic",
+ "description" : "",
+ "operationId" : "getMessageTTL",
+ "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" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, enable the topic level policy and retry"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set message TTL in seconds for a topic",
+ "description" : "",
+ "operationId" : "setMessageTTL",
+ "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" : "messageTTL",
+ "in" : "query",
+ "description" : "TTL in seconds for the specified namespace",
+ "required" : true,
+ "type" : "integer",
+ "format" : "int32"
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Not authenticate to perform the request or policy is read only"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, enable the topic level policy and retry"
+ },
+ "412" : {
+ "description" : "Invalid message TTL value"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Remove message TTL in seconds for a topic",
+ "description" : "",
+ "operationId" : "removeMessageTTL",
+ "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" : "isGlobal",
+ "in" : "query",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "authoritative",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Not authenticate to perform the request or policy is read only"
+ },
+ "404" : {
+ "description" : "Topic does not exist"
+ },
+ "405" : {
+ "description" : "Topic level policy is disabled, enable the topic level policy and retry"
+ },
+ "412" : {
+ "description" : "Invalid message TTL value"
+ }
+ }
+ }
+ },
+ "/non-persistent/{tenant}/{namespace}/{topic}/messageid/{timestamp}" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get message ID published at or just after this absolute timestamp (in ms).",
+ "description" : "",
+ "operationId" : "getMessageIdByTimestamp",
+ "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" : "timestamp",
+ "in" : "path",
+ "description" : "Specify the timestamp",
+ "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 does not exist"
+ },
+ "405" : {
+ "description" : "Topic is not non-partitioned and persistent"
+ },
+ "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" : {
+ "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"
+ },
+ "400" : {
+ "description" : "Message ID is null"
+ },
+ "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}/offloadPolicies" : {
+ "get" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Get offload policies on a topic.",
+ "description" : "",
+ "operationId" : "getOffloadPolicies",
+ "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" : "applied",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ },
+ "500" : {
+ "description" : "Internal server error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Set offload policies on a topic.",
+ "description" : "",
+ "operationId" : "setOffloadPolicies",
+ "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",
+ "description" : "Is authentication required to perform this operation",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "isGlobal",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Offload policies for the specified topic",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/OffloadPoliciesImpl"
+ }
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "non-persistent topic" ],
+ "summary" : "Delete offload policies on a topic.",
+ "description" : "",
+ "operationId" : "removeOffloadPolicies",
+ "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" : "isGlobal",
+ "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
+ } ],
+ "responses" : {
+ "403" : {
+ "description" : "Don't have admin permission"
+ },
+ "404" : {
+ "description" : "Tenant or cluster or namespace or topic doesn't exist"
+ }
+ }
+ }
+ },
+ "/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" : "If return precise backlog or imprecise backlog",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "subscriptionBacklogSize",
+ "in" : "query",
+ "description" : "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.",
+ "required" : false,
+ "type" : "boolean",
+ "default" : false
+ }, {
+ "name" : "getEarliestTimeInBacklog",
+ "in" : "query",
+ "description" : "If return the earliest time in 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",
... 91891 lines suppressed ...
[pulsar-site] 03/03: feat: only build en and zh-CN
Posted by ur...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
commit cb824c7d6f3f45c39606bd9df635e11f5f0d9091
Author: Li Li <ur...@apache.org>
AuthorDate: Sat May 7 16:43:37 2022 +0800
feat: only build en and zh-CN
Signed-off-by: Li Li <ur...@apache.org>
---
site2/website-next/docusaurus.config.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/site2/website-next/docusaurus.config.js b/site2/website-next/docusaurus.config.js
index 283a439c47..181e54cdb1 100644
--- a/site2/website-next/docusaurus.config.js
+++ b/site2/website-next/docusaurus.config.js
@@ -129,7 +129,7 @@ module.exports = {
},
i18n: {
defaultLocale: "en",
- locales: ["en", "zh-CN", "zh-TW", "ja", "fr", "ko"],
+ locales: ["en", "zh-CN"], //, "zh-TW", "ja", "fr", "ko"
localeConfigs: {
"zh-CN": {
label: "简体中文",
[pulsar-site] 01/03: sync website from pulsar
Posted by ur...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
commit e174ec9ee4288f9f8db9aabb25369e6470cde5b5
Author: Li Li <ur...@apache.org>
AuthorDate: Sat May 7 16:36:13 2022 +0800
sync website from pulsar
---
site2/website/data/resources.js | 22 ++
site2/website/package.json | 3 +-
site2/website/pages/en/contact.js | 16 +-
site2/website/pages/en/download.js | 10 +-
site2/website/pages/en/index.js | 1 -
site2/website/pages/en/resources.js | 20 ++
site2/website/scripts/replace.js | 6 +-
site2/website/siteConfig.js | 79 ++++---
.../versioned_docs/version-2.5.1/standalone.md | 230 ---------------------
9 files changed, 104 insertions(+), 283 deletions(-)
diff --git a/site2/website/data/resources.js b/site2/website/data/resources.js
index 071da4a4c4..2158c74f4e 100644
--- a/site2/website/data/resources.js
+++ b/site2/website/data/resources.js
@@ -1,4 +1,26 @@
module.exports = {
+ books: [
+ {
+ book: 'Apache Pulsar in Action',
+ author: "David Kjerrumgaard",
+ link: 'https://www.manning.com/books/apache-pulsar-in-action/'
+ },
+ {
+ book: 'Mastering Apache Pulsar',
+ author: "Jowanza Joseph",
+ link: 'https://www.oreilly.com/library/view/mastering-apache-pulsar/9781492084891/'
+ },
+ {
+ book: 'Cloud-Native Microservices with Apache Pulsar',
+ author: "Rahul Sharma, Mohammad Atyab",
+ link: 'https://link.springer.com/book/10.1007/978-1-4842-7839-0'
+ },
+ {
+ book: '深入解析 Apache Pulsar（Chinese Book, which means "Deep Dive into Apache Pulsar")',
+ author: "Lin Lin",
+ link: 'https://www.phei.com.cn/module/goods/wssd_content.jsp?bookid=59310'
+ }
+ ],
articles: [
{
forum: 'Pedro Silvestre',
diff --git a/site2/website/package.json b/site2/website/package.json
index f28977f241..e0cd20be17 100644
--- a/site2/website/package.json
+++ b/site2/website/package.json
@@ -34,5 +34,6 @@
"jquery": "^3.1.1",
"jquery.scrollto": "^2.1.2",
"node-static": "^0.7.9"
- }
+ },
+ "license": "Apache-2.0"
}
diff --git a/site2/website/pages/en/contact.js b/site2/website/pages/en/contact.js
index 57f6aba8e3..24acede177 100644
--- a/site2/website/pages/en/contact.js
+++ b/site2/website/pages/en/contact.js
@@ -50,9 +50,9 @@ class Contact extends React.Component {
There are many ways to get help from the Apache Pulsar community.
The mailing lists are the primary place where all Pulsar committers are present.
Bugs and feature requests can either be discussed on the dev mailing list or
- by opening an issue on
- <a href="https://github.com/apache/pulsar/" target="_blank">GitHub</a>.
- </translate></p>
+ by opening an issue on</translate>
+ <a href="https://github.com/apache/pulsar/" target="_blank"> GitHub</a>.
+ </p>
<h2><translate>Mailing Lists</translate></h2>
<table className="versions">
@@ -79,6 +79,16 @@ class Contact extends React.Component {
)}
</tbody>
</table>
+ <h2><translate>Reporting Security Vulnerabilities</translate></h2>
+ <p><translate>
+ The current process for reporting vulnerabilities is outlined here: </translate>
+ <a href="https://www.apache.org/security/" target="_blank"> Apache Security</a>
+ <translate>. When reporting a vulnerability to</translate>
+ <a href="mailto:security@apache.org" target="_blank"> security@apache.org</a>
+ <translate>, you can copy your email to </translate>
+ <a href="mailto:private@pulsar.apache.org" target="_blank"> private@pulsar.apache.org </a>
+ <translate> to send your report to the Apache Pulsar Project Management Committee. This is a private mailing list.</translate>
+ </p>
<h2><translate>Stack Overflow</translate></h2>
<p><translate>
diff --git a/site2/website/pages/en/download.js b/site2/website/pages/en/download.js
index 3dbb232620..65a802f83d 100644
--- a/site2/website/pages/en/download.js
+++ b/site2/website/pages/en/download.js
@@ -28,11 +28,11 @@ function getLatestAdaptersMirrorUrl(version) {
}
function distUrl(version, type) {
- return `https://www.apache.org/dist/pulsar/pulsar-${version}/apache-pulsar-${version}-${type}.tar.gz`
+ return `https://downloads.apache.org/pulsar/pulsar-${version}/apache-pulsar-${version}-${type}.tar.gz`
}
function distOffloadersUrl(version) {
- return `https://www.apache.org/dist/pulsar/pulsar-${version}/apache-pulsar-offloaders-${version}-bin.tar.gz`
+ return `https://downloads.apache.org//pulsar/pulsar-${version}/apache-pulsar-offloaders-${version}-bin.tar.gz`
}
function distAdaptersUrl(version) {
@@ -52,7 +52,7 @@ function pularManagerArchiveUrl(version, type) {
}
function connectorDistUrl(name, version) {
- return `https://www.apache.org/dist/pulsar/pulsar-${version}/connectors/pulsar-io-${name}-${version}.nar`
+ return `https://downloads.apache.org/pulsar/pulsar-${version}/connectors/pulsar-io-${name}-${version}.nar`
}
function connectorDownloadUrl(name, version) {
@@ -64,7 +64,7 @@ function getLatestPulsarManagerArchiveMirrorUrl(version, type) {
}
function pulsarManagerDistUrl(version, type) {
- return `https://www.apache.org/dist/pulsar/pulsar-manager/pulsar-manager-${version}/apache-pulsar-manager-${version}-${type}.tar.gz`
+ return `https://downloads.apache.org/pulsar/pulsar-manager/pulsar-manager-${version}/apache-pulsar-manager-${version}-${type}.tar.gz`
}
class Download extends React.Component {
@@ -204,7 +204,7 @@ class Download extends React.Component {
<MarkdownBlock>
You must [verify](https://www.apache.org/info/verification.html) the integrity of the downloaded files.
We provide OpenPGP signatures for every release file. This signature should be matched against the
- [KEYS](https://www.apache.org/dist/pulsar/KEYS) file which contains the OpenPGP keys of
+ [KEYS](https://downloads.apache.org/pulsar/KEYS) file which contains the OpenPGP keys of
Pulsar's Release Managers. We also provide `SHA-512` checksums for every release file.
After you download the file, you should calculate a checksum for your download, and make sure it is
the same as ours.
diff --git a/site2/website/pages/en/index.js b/site2/website/pages/en/index.js
index de3ed123bc..a24fbeb72a 100755
--- a/site2/website/pages/en/index.js
+++ b/site2/website/pages/en/index.js
@@ -23,7 +23,6 @@ function docUrl(doc, language) {
return siteConfig.baseUrl + 'docs/' + (language ? language + '/' : '') + doc;
}
-
function pageUrl(page, language) {
return siteConfig.baseUrl + (language ? language + '/' : '') + page;
}
diff --git a/site2/website/pages/en/resources.js b/site2/website/pages/en/resources.js
index ebf2926685..9c5b89c17f 100644
--- a/site2/website/pages/en/resources.js
+++ b/site2/website/pages/en/resources.js
@@ -26,6 +26,26 @@ class Resources extends React.Component {
<hr />
</header>
+ <h2><translate>Books</translate></h2>
+ <table className="versions">
+ <thead>
+ <tr>
+ <th><translate>Book</translate></th>
+ <th><translate>Author</translate></th>
+ </tr>
+ </thead>
+ <tbody>
+ {resources.books.map(
+ (a, i) => (
+ <tr key={i}>
+ <td><a href={a.link}>{a.book}</a></td>
+ <td>{a.author}</td>
+ </tr>
+ )
+ )}
+ </tbody>
+ </table>
+
<h2><translate>Articles</translate></h2>
<table className="versions">
<thead>
diff --git a/site2/website/scripts/replace.js b/site2/website/scripts/replace.js
index f843dfbc76..540ae51be9 100644
--- a/site2/website/scripts/replace.js
+++ b/site2/website/scripts/replace.js
@@ -36,9 +36,9 @@ function connectorReleaseUrl(version) {
if (version.includes('incubating')) {
return `https://archive.apache.org/dist/incubator/pulsar/pulsar-${version}/apache-pulsar-io-connectors-${version}-bin.tar.gz`
} else if (majorVersion > 2 || (majorVersion == 2 && minorVersion >= 3)) {
- return `https://archive.apache.org/dist/pulsar/pulsar-${version}/connectors`;
+ return `https://archive.apache.org/dist/pulsar/pulsar-${version}/connectors`
} else {
- return `https://archive.apache.org/dist/pulsar/pulsar-${version}/apache-pulsar-io-connectors-${version}-bin.tar.gz`;
+ return `https://archive.apache.org/dist/pulsar/pulsar-${version}/apache-pulsar-io-connectors-${version}-bin.tar.gz`
}
}
@@ -92,7 +92,7 @@ function clientVersionUrl(version, type) {
var versions = version.split('.')
var majorVersion = parseInt(versions[0])
var minorVersion = parseInt(versions[1])
- if (majorVersion === 2 && minorVersion < 5) {
+ if ((majorVersion === 2 && minorVersion < 5) || (type === "python" && minorVersion >= 7)) {
return `/api/` + type + `/` + version;
} else if (majorVersion >= 2 && minorVersion >= 5) {
return `/api/` + type + `/` + majorVersion + `.` + minorVersion + `.0` + `-SNAPSHOT`
diff --git a/site2/website/siteConfig.js b/site2/website/siteConfig.js
index 444f71b4b4..5607a6230b 100644
--- a/site2/website/siteConfig.js
+++ b/site2/website/siteConfig.js
@@ -102,9 +102,9 @@ const siteVariables = {
};
const siteConfig = {
- title: 'Apache Pulsar' /* title for your website */,
+ title: "Apache Pulsar" /* title for your website */,
disableTitleTagline: true,
- tagline: '',
+ tagline: "",
url: url /* your website url */,
baseUrl: baseUrl /* base url for your project */,
// For github.io type URLs, you would set the url and baseUrl like:
@@ -114,81 +114,82 @@ const siteConfig = {
editUrl: `${githubUrl}/edit/master/site2/docs/`,
// Used for publishing and more
- projectName: 'pulsar',
- organizationName: 'apache',
+ projectName: "pulsar",
+ organizationName: "apache",
// For top-level user or org sites, the organization is still the same.
// e.g., for the https://JoelMarcey.github.io site, it would be set like...
// organizationName: 'JoelMarcey'
// For no header links in the top nav bar -> headerLinks: [],
headerLinks: [
- {doc: 'standalone', label: 'Docs'},
- {page: 'download', label: 'Download'},
- {doc: 'client-libraries', label: 'Clients'},
- {href: '#restapis', label: 'REST APIs'},
- {href: '#cli', label: 'Cli'},
- {blog: true, label: 'Blog'},
- {href: '#community', label: 'Community'},
- {href: '#apache', label: 'Apache'},
- { href: 'https://pulsar-next.staged.apache.org/', label: 'New Website' },
+ { doc: "getting-started-standalone", label: "Docs" },
+ { page: "download", label: "Download" },
+ { doc: "client-libraries", label: "Clients" },
+ { href: "#restapis", label: "REST APIs" },
+ { href: "#cli", label: "Cli" },
+ { blog: true, label: "Blog" },
+ { href: "#community", label: "Community" },
+ { href: "#apache", label: "Apache" },
+ {
+ href: "https://pulsar-next.staged.apache.org/",
+ label: "New Website (Beta)",
+ },
// Determines search bar position among links
//{ search: true },
// Determines language drop down position among links
- { languages: true }
+ { languages: true },
],
// If you have users set above, you add it here:
users: [],
/* path to images for header/footer */
- headerIcon: 'img/pulsar.svg',
- footerIcon: 'img/pulsar.svg',
- favicon: 'img/pulsar.ico',
+ headerIcon: "img/pulsar.svg",
+ footerIcon: "img/pulsar.svg",
+ favicon: "img/pulsar.ico",
algolia: {
- apiKey: 'd226a455cecdd4bc18a554c1b47e5b52',
- indexName: 'apache_pulsar',
+ apiKey: "d226a455cecdd4bc18a554c1b47e5b52",
+ indexName: "apache_pulsar",
algoliaOptions: {
- facetFilters: ['language:LANGUAGE', 'version:VERSION'],
+ facetFilters: ["language:LANGUAGE", "version:VERSION"],
},
},
- gaTrackingId: 'UA-102219959-1',
+ gaTrackingId: "UA-102219959-1",
/* colors for website */
colors: {
- primaryColor: '#188fff',
- secondaryColor: '#205C3B',
+ primaryColor: "#188fff",
+ secondaryColor: "#205C3B",
},
- translationRecruitingLink: 'https://crowdin.com/project/apache-pulsar',
+ translationRecruitingLink: "https://crowdin.com/project/apache-pulsar",
// This copyright info is used in /core/Footer.js and blog rss/atom feeds.
copyright:
- 'Copyright © ' +
+ "Copyright © " +
new Date().getFullYear() +
- ' The Apache Software Foundation. All Rights Reserved.' +
- ' Apache, Apache Pulsar and the Apache feather logo are trademarks of The Apache Software Foundation.',
+ " The Apache Software Foundation. All Rights Reserved." +
+ " Apache, Apache Pulsar and the Apache feather logo are trademarks of The Apache Software Foundation.",
highlight: {
// Highlight.js theme to use for syntax highlighting in code blocks
- theme: 'atom-one-dark',
+ theme: "atom-one-dark",
},
// Add custom scripts here that would be placed in <script> tags
scripts: [
- 'https://buttons.github.io/buttons.js',
- 'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
- `${baseUrl}js/custom.js`
- ],
- stylesheets: [
- `${baseUrl}css/code-blocks-buttons.css`
+ "https://buttons.github.io/buttons.js",
+ "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
+ `${baseUrl}js/custom.js`,
],
+ stylesheets: [`${baseUrl}css/code-blocks-buttons.css`],
/* On page navigation for the current documentation page */
- onPageNav: 'separate',
+ onPageNav: "separate",
/* Open Graph and Twitter card images */
//ogImage: 'img/docusaurus.png',
twitter: true,
- twitterUsername: 'apache_pulsar',
- twitterImage: 'img/pulsar.svg',
+ twitterUsername: "apache_pulsar",
+ twitterImage: "img/pulsar.svg",
disableHeaderTitle: true,
@@ -205,9 +206,7 @@ const siteConfig = {
created at Yahoo! and now a top-level Apache Software Foundation project
`,
- markdownPlugins: [
- createVariableInjectionPlugin(siteVariables)
- ],
+ markdownPlugins: [createVariableInjectionPlugin(siteVariables)],
};
module.exports = siteConfig;
diff --git a/site2/website/versioned_docs/version-2.5.1/standalone.md b/site2/website/versioned_docs/version-2.5.1/standalone.md
deleted file mode 100644
index cff185c59a..0000000000
--- a/site2/website/versioned_docs/version-2.5.1/standalone.md
+++ /dev/null
@@ -1,230 +0,0 @@
----
-id: version-2.5.1-standalone
-title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
----
-
-For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
-
-> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
-
-## Install Pulsar standalone
-
-This tutorial guides you through every step of the installation process.
-
-### System requirements
-
-Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
-
-> **Note**
->
-> Broker is only supported on 64-bit JVM.
-
-### Install Pulsar using binary release
-
-To get started with Pulsar, download a binary tarball release in one of the following ways:
-
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
-
-* download from the Pulsar [downloads page](pulsar:download_page_url)
-
-* download from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
-
-* use [wget](https://www.gnu.org/software/wget):
-
- ```shell
- $ wget pulsar:binary_release_url
- ```
-
-After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
-
-```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
-```
-
-#### What your package contains
-
-The Pulsar binary package initially contains the following directories:
-
-Directory | Contains
-:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
-`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
-`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
-`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
-
-These directories are created once you begin running Pulsar.
-
-Directory | Contains
-:---------|:--------
-`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
-`logs` | Logs created by the installation.
-
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
-
-### Install builtin connectors (optional)
-
-Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
-To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
-
-* download from the Pulsar [downloads page](pulsar:download_page_url)
-
-* download from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
-
-* use [wget](https://www.gnu.org/software/wget):
-
- ```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
- ```
-
-After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
-
-```bash
-$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
-
-$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
-...
-```
-
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
-
-### Install tiered storage offloaders (optional)
-
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
-
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
-
-* download from the Pulsar [downloads page](pulsar:download_page_url)
-
-* download from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
-
-* use [wget](https://www.gnu.org/software/wget):
-
- ```shell
- $ wget pulsar:offloader_release_url
- ```
-
-After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
-in the pulsar directory:
-
-```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
-// then copy the offloaders
-
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
-
-$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
-```
-
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
-
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
-
-## Start Pulsar standalone
-
-Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
-
-```bash
-$ bin/pulsar standalone
-```
-
-If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
-
-```bash
-2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
-2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
-2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
-```
-
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
-You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
->
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
->
-> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
-
-## Use Pulsar standalone
-
-Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsar-client). The pulsar-client tool enables you to consume and produce messages to a Pulsar topic in a running cluster.
-
-### Consume a message
-
-The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
-
-```bash
-$ bin/pulsar-client consume my-topic -s "first-subscription"
-```
-
-If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
-
-```
-09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
-```
-
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
-
-### Produce a message
-
-The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
-
-```bash
-$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
-```
-
-If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
-
-```
-13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
-```
-
-## Stop Pulsar standalone
-
-Press `Ctrl+C` to stop a local standalone Pulsar.
-
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).