You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ti...@apache.org on 2022/12/15 14:24:49 UTC
[pulsar-site] branch main updated (54280f171b7 -> 0db05b762ce)
This is an automated email from the ASF dual-hosted git repository.
tison pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
from 54280f171b7 Update release process for references/API docs generation (#337)
new 476602df2c5 sort swagger output
new 0db05b762ce Stably generate swagger files
The 2 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:
.../static/swagger/master/swagger.json | 58828 ++++++++++---------
.../static/swagger/master/swaggerfunctions.json | 6354 +-
.../static/swagger/master/swaggerlookup.json | 2839 +-
.../static/swagger/master/swaggerpackages.json | 3385 +-
.../static/swagger/master/swaggersink.json | 4889 +-
.../static/swagger/master/swaggersource.json | 4770 +-
.../static/swagger/master/swaggertransactions.json | 3885 +-
.../static/swagger/master/v2/swagger.json | 44374 +++++++-------
.../static/swagger/master/v2/swaggerlookup.json | 1476 +-
.../static/swagger/master/v3/swaggerfunctions.json | 5710 +-
.../static/swagger/master/v3/swaggerpackages.json | 2342 +-
.../static/swagger/master/v3/swaggersink.json | 4414 +-
.../static/swagger/master/v3/swaggersource.json | 4286 +-
.../swagger/master/v3/swaggertransactions.json | 3086 +-
tools/pytools/lib/execute/swagger_generator.py | 8 +-
15 files changed, 78272 insertions(+), 72374 deletions(-)
[pulsar-site] 02/02: Stably generate swagger files
Posted by ti...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
commit 0db05b762ce9939e9b9251798508b06935bd26cc
Author: tison <wa...@gmail.com>
AuthorDate: Thu Dec 15 22:24:30 2022 +0800
Stably generate swagger files
Signed-off-by: tison <wa...@gmail.com>
---
.../static/swagger/master/swagger.json | 58828 ++++++++++---------
.../static/swagger/master/swaggerfunctions.json | 6354 +-
.../static/swagger/master/swaggerlookup.json | 2839 +-
.../static/swagger/master/swaggerpackages.json | 3385 +-
.../static/swagger/master/swaggersink.json | 4889 +-
.../static/swagger/master/swaggersource.json | 4770 +-
.../static/swagger/master/swaggertransactions.json | 3885 +-
.../static/swagger/master/v2/swagger.json | 44374 +++++++-------
.../static/swagger/master/v2/swaggerlookup.json | 1476 +-
.../static/swagger/master/v3/swaggerfunctions.json | 5710 +-
.../static/swagger/master/v3/swaggerpackages.json | 2342 +-
.../static/swagger/master/v3/swaggersink.json | 4414 +-
.../static/swagger/master/v3/swaggersource.json | 4286 +-
.../swagger/master/v3/swaggertransactions.json | 3086 +-
14 files changed, 78266 insertions(+), 72372 deletions(-)
diff --git a/site2/website-next/static/swagger/master/swagger.json b/site2/website-next/static/swagger/master/swagger.json
index ee6aab2179f..144aa124577 100644
--- a/site2/website-next/static/swagger/master/swagger.json
+++ b/site2/website-next/static/swagger/master/swagger.json
@@ -1,27314 +1,32086 @@
{
- "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"
+ "basePath": "/admin/v2",
+ "definitions": {
+ "AllocatorStats": {
+ "properties": {
+ "directArenas": {
+ "items": {
+ "$ref": "#/definitions/PoolArenaStats"
+ },
+ "type": "array"
+ },
+ "heapArenas": {
+ "items": {
+ "$ref": "#/definitions/PoolArenaStats"
+ },
+ "type": "array"
+ },
+ "normalCacheSize": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "numDirectArenas": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "numHeapArenas": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "numThreadLocalCaches": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "smallCacheSize": {
+ "format": "int32",
+ "type": "integer"
}
- }
- }
- },
- "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 namespace",
- "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" : {
- "get" : {
- "tags" : [ "brokers" ],
- "summary" : "Get the list of active brokers (web service addresses) in the local cluster.If authorization is not enabled",
- "description" : "",
- "operationId" : "getActiveBrokers",
- "produces" : [ "application/json" ],
- "responses" : {
- "200" : {
- "description" : "successful operation",
- "schema" : {
- "type" : "array",
- "uniqueItems" : true,
- "items" : {
- "type" : "string"
- }
- }
- },
- "401" : {
- "description" : "Authentication required"
- },
- "403" : {
- "description" : "This operation requires super-user access"
- }
- }
- }
- },
- "/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" : {
- "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" : {
- "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" : {
- "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}/migrate" : {
- "post" : {
- "tags" : [ "clusters" ],
- "summary" : "Update the configuration for a cluster migration.",
- "description" : "This operation requires Pulsar superuser privileges.",
- "operationId" : "updateClusterMigration",
- "produces" : [ "application/json" ],
- "parameters" : [ {
- "name" : "cluster",
- "in" : "path",
- "description" : "The cluster name",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "migrated",
- "in" : "query",
- "description" : "Is cluster migrated",
- "required" : true,
- "type" : "boolean"
- }, {
- "in" : "body",
- "name" : "body",
- "description" : "The cluster url data",
- "required" : true,
- "schema" : {
- "$ref" : "#/definitions/ClusterUrl"
- },
- "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."
- },
- "400" : {
- "description" : "Cluster url must not be empty."
- },
- "403" : {
- "description" : "Don't have admin permission or policies are read-only."
- },
- "404" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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}/entryFilters" : {
- "get" : {
- "tags" : [ "namespaces" ],
- "summary" : "Get maxConsumersPerSubscription config on a namespace.",
- "description" : "",
- "operationId" : "getEntryFiltersPerTopic",
- "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"
- }
- }
- },
- "post" : {
- "tags" : [ "namespaces" ],
- "summary" : "Set entry filters for namespace",
- "description" : "",
- "operationId" : "setEntryFiltersPerTopic",
- "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" : "entry filters",
- "required" : true,
- "schema" : {
- "$ref" : "#/definitions/EntryFilters"
- }
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Tenant or cluster or namespace doesn't exist"
- }
- }
- },
- "delete" : {
- "tags" : [ "namespaces" ],
- "summary" : "Remove entry filters for namespace",
- "description" : "",
- "operationId" : "removeNamespaceEntryFilters",
- "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}/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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : "Remove 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" : {
- "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" : {
- "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" : {
- "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}/offloadThresholdInSeconds" : {
- "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" : "getOffloadThresholdInSeconds",
- "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"
- }
- }
- },
- "put" : {
- "tags" : [ "namespaces" ],
- "summary" : "Set maximum number of seconds 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" : "setOffloadThresholdInSeconds",
- "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"
- },
- "412" : {
- "description" : "offloadThresholdInSeconds 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" : {
- "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" : {
- "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" : {
- "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" : "Clear properties on a given 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" : {
- "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 resource group 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" : {
- "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" : {
- "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}/scanOffloadedLedgers" : {
- "get" : {
- "tags" : [ "namespaces" ],
- "summary" : "Trigger the scan of offloaded Ledgers on the LedgerOffloader for the given namespace",
- "description" : "",
- "operationId" : "scanOffloadedLedgers",
- "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"
- }
- }
- }
- },
- "/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" : {
- "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" : {
- "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" : "setSchemaValidationEnforced",
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" : {
- "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" ]
- }, {
- "name" : "includeSystemTopic",
- "in" : "query",
- "description" : "Include system topic",
- "required" : false,
- "type" : "boolean"
- } ],
- "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"
- }, {
- "in" : "body",
- "name" : "body",
- "description" : "splitBoundaries",
- "required" : false,
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "integer",
- "format" : "int64"
- }
- }
- } ],
- "responses" : {
- "307" : {
- "description" : "Current broker doesn't serve the namespace"
- },
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace doesn't exist"
- }
- }
- }
- },
- "/namespaces/{tenant}/{namespace}/{bundle}/topicHashPositions" : {
- "get" : {
- "tags" : [ "namespaces" ],
- "summary" : "Get hash positions for topics",
- "description" : "",
- "operationId" : "getTopicHashPositions",
- "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" : "topics",
- "in" : "query",
- "required" : false,
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "collectionFormat" : "multi"
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace does not exist"
- }
- }
- }
- },
- "/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"
- },
- "404" : {
- "description" : "Namespace doesn't exist"
- }
- }
- }
- },
- "/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"
- }, {
- "name" : "includeSystemTopic",
- "in" : "query",
- "description" : "Include system topic",
- "required" : false,
- "type" : "boolean"
- } ],
- "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"
- }, {
- "name" : "includeSystemTopic",
- "in" : "query",
- "description" : "Include system topic",
- "required" : false,
- "type" : "boolean"
- } ],
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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"
- },
- "404" : {
- "description" : "Tenant or namespace doesn't exist"
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or 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}/autoSubscriptionCreation" : {
- "get" : {
- "tags" : [ "non-persistent topic" ],
- "summary" : "Get autoSubscriptionCreation info in a topic",
- "description" : "",
- "operationId" : "getAutoSubscriptionCreation",
- "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",
- "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" : "Override namespace's allowAutoSubscriptionCreation setting for a topic",
- "description" : "",
- "operationId" : "setAutoSubscriptionCreation",
- "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",
- "required" : false,
- "type" : "boolean",
- "default" : false
- }, {
- "in" : "body",
- "name" : "body",
- "description" : "Settings for automatic subscription creation",
- "required" : false,
- "schema" : {
- "$ref" : "#/definitions/AutoSubscriptionCreationOverrideImpl"
- }
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Topic doesn't exist"
- },
- "405" : {
- "description" : "Topic level policy is disabled, enable the topic level policy and retry"
- },
- "409" : {
- "description" : "Concurrent modification"
- }
- }
- },
- "delete" : {
- "tags" : [ "non-persistent topic" ],
- "summary" : "Remove autoSubscriptionCreation ina a topic.",
- "description" : "",
- "operationId" : "removeAutoSubscriptionCreation",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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}/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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" ]
- }, {
- "in" : "body",
- "name" : "body",
- "description" : "backlog quota policies for the specified topic",
- "required" : false,
- "schema" : {
- "$ref" : "#/definitions/BacklogQuotaImpl"
- }
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "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"
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "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}/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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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 or namespace 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace or 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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",
- "required" : false,
- "type" : "boolean",
- "default" : false
- }, {
- "name" : "authoritative",
- "in" : "query",
- "description" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace or topic doesn't 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}/entryFilters" : {
- "get" : {
- "tags" : [ "non-persistent topic" ],
- "summary" : "Get entry filters for a topic.",
- "description" : "",
- "operationId" : "getEntryFilters",
- "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" : "applied",
- "in" : "query",
- "required" : false,
- "type" : "boolean",
- "default" : false
- }, {
- "name" : "isGlobal",
- "in" : "query",
- "required" : false,
- "type" : "boolean",
- "default" : false
- }, {
- "name" : "authoritative",
- "in" : "query",
- "description" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Tenants or Namespace doesn't exist"
- }
- }
- },
- "post" : {
- "tags" : [ "non-persistent topic" ],
- "summary" : "Set entry filters for specified topic",
- "description" : "",
- "operationId" : "setEntryFilters",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- }, {
- "in" : "body",
- "name" : "body",
- "description" : "Enable sub types for the specified topic",
- "required" : false,
- "schema" : {
- "$ref" : "#/definitions/EntryFilters"
- }
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Tenant or namespace or topic doesn't 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 entry filters for specified topic.",
- "description" : "",
- "operationId" : "removeEntryFilters",
- "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" : "Whether leader broker redirected thiscall to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Tenant or namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- }, {
- "name" : "metadata",
- "in" : "query",
- "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 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "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"
- }
- }
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "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"
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "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}/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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "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"
- }
- }
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "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"
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "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}/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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "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"
- }
- }
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "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"
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "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}/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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "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"
- }
- }
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "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"
- },
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "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}/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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Don't have admin permission"
- },
- "404" : {
- "description" : "Namespace or topic doesn't 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 topic",
- "required" : true,
- "type" : "integer",
- "format" : "int32"
- }, {
- "name" : "isGlobal",
- "in" : "query",
- "required" : false,
- "type" : "boolean",
- "default" : false
- }, {
- "name" : "authoritative",
- "in" : "query",
- "description" : "Whether leader broker redirected this call to this broker. For internal use.",
- "required" : false,
- "type" : "boolean",
- "default" : false
- } ],
- "responses" : {
- "403" : {
- "description" : "Not authenticate to perform the request or policy is read only"
- },
- "404" : {
- "description" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or topic doesn't 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or 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" : "Whether leader broker redirected this call to this broker. For internal use.",
- "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" : "Namespace or topic does not exist"
... 153656 lines suppressed ...
[pulsar-site] 01/02: sort swagger output
Posted by ti...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
commit 476602df2c5ad21606031007dbadafa7d2e5fec2
Author: tison <wa...@gmail.com>
AuthorDate: Thu Dec 15 22:21:36 2022 +0800
sort swagger output
Signed-off-by: tison <wa...@gmail.com>
---
tools/pytools/lib/execute/swagger_generator.py | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/tools/pytools/lib/execute/swagger_generator.py b/tools/pytools/lib/execute/swagger_generator.py
index 109c497b204..b61675d2692 100644
--- a/tools/pytools/lib/execute/swagger_generator.py
+++ b/tools/pytools/lib/execute/swagger_generator.py
@@ -15,7 +15,7 @@
# specific language governing permissions and limitations
# under the License.
-import shutil
+import json
from pathlib import Path
from command import find_command, run
@@ -29,4 +29,8 @@ def execute(master: Path, version: str):
mvn = find_command('mvn', msg="mvn is required")
run(mvn, '-pl', 'pulsar-broker', 'install', '-DskipTests', '-Pswagger', cwd=master)
- shutil.copytree(master_swaggers, site_path() / 'static' / 'swagger' / version, dirs_exist_ok=True)
+ for f in master_swaggers.glob('*.json'):
+ data = json.loads(f.read_text())
+ with (site_path() / 'static' / 'swagger' / version / f'{f.stem}.json').open('w+') as m:
+ json.dump(data, m, indent=4, sort_keys=True)
+ m.write('\n')