You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ur...@apache.org on 2024/01/22 01:34:01 UTC

(pulsar-site) branch main updated: Docs sync done from apache/pulsar (#6347315)

This is an automated email from the ASF dual-hosted git repository.

urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git


The following commit(s) were added to refs/heads/main by this push:
     new f45e6c9c1b8a Docs sync done from apache/pulsar (#6347315)
f45e6c9c1b8a is described below

commit f45e6c9c1b8ae4cb9e5db40dda6c734b557f7528
Author: github-actions[bot] <41...@users.noreply.github.com>
AuthorDate: Mon Jan 22 01:33:56 2024 +0000

    Docs sync done from apache/pulsar (#6347315)
---
 static/reference/next/pulsar-admin/namespaces.md |  48 ++++++++
 static/swagger/master/swagger.json               | 142 +++++++++++++++++++++--
 static/swagger/master/v2/swagger.json            | 142 +++++++++++++++++++++--
 3 files changed, 310 insertions(+), 22 deletions(-)

diff --git a/static/reference/next/pulsar-admin/namespaces.md b/static/reference/next/pulsar-admin/namespaces.md
index 13fab4cbab7b..cd90759fe075 100644
--- a/static/reference/next/pulsar-admin/namespaces.md
+++ b/static/reference/next/pulsar-admin/namespaces.md
@@ -2304,3 +2304,51 @@ $ pulsar-admin namespaces update-migration-state options
 |---|---|---|
 | `--migrated` | Is namespace migrated|false||
 
+
+## set-dispatcher-pause-on-ack-state-persistent
+
+Enable dispatcherPauseOnAckStatePersistent for a namespace
+
+**Command:**
+
+```shell
+$ pulsar-admin namespaces set-dispatcher-pause-on-ack-state-persistent options
+```
+
+**Options:**
+
+|Flag|Description|Default|
+|---|---|---|
+
+
+## get-dispatcher-pause-on-ack-state-persistent
+
+Get the dispatcherPauseOnAckStatePersistent for a namespace
+
+**Command:**
+
+```shell
+$ pulsar-admin namespaces get-dispatcher-pause-on-ack-state-persistent options
+```
+
+**Options:**
+
+|Flag|Description|Default|
+|---|---|---|
+
+
+## remove-dispatcher-pause-on-ack-state-persistent
+
+Remove dispatcherPauseOnAckStatePersistent for a namespace
+
+**Command:**
+
+```shell
+$ pulsar-admin namespaces remove-dispatcher-pause-on-ack-state-persistent options
+```
+
+**Options:**
+
+|Flag|Description|Default|
+|---|---|---|
+
diff --git a/static/swagger/master/swagger.json b/static/swagger/master/swagger.json
index 80b27eeb4f36..bef13a82c774 100644
--- a/static/swagger/master/swagger.json
+++ b/static/swagger/master/swagger.json
@@ -1345,22 +1345,23 @@
                     "format": "int64",
                     "type": "integer"
                 },
+                "isOffloaded": {
+                    "type": "boolean"
+                },
                 "ledgerId": {
                     "format": "int64",
                     "type": "integer"
                 },
-                "metadata": {
+                "offloadedContextUuid": {
                     "type": "string"
                 },
-                "offloaded": {
-                    "type": "boolean"
-                },
                 "size": {
                     "format": "int64",
                     "type": "integer"
                 },
-                "underReplicated": {
-                    "type": "boolean"
+                "timestamp": {
+                    "format": "int64",
+                    "type": "integer"
                 }
             },
             "type": "object"
@@ -3122,6 +3123,9 @@
                 "deleted": {
                     "type": "boolean"
                 },
+                "dispatcherPauseOnAckStatePersistentEnabled": {
+                    "type": "boolean"
+                },
                 "encryption_required": {
                     "type": "boolean"
                 },
@@ -5045,7 +5049,7 @@
                         "description": "This operation requires super-user access"
                     }
                 },
-                "summary": "Get the list of active brokers (web service addresses) in the local cluster.If authorization is not enabled",
+                "summary": "Get the list of active brokers (broker ids) in the local cluster.If authorization is not enabled",
                 "tags": [
                     "brokers"
                 ]
@@ -5393,7 +5397,7 @@
                 ]
             }
         },
-        "/brokers/{clusterName}/{broker-webserviceurl}/ownedNamespaces": {
+        "/brokers/{clusterName}/{brokerId}/ownedNamespaces": {
             "get": {
                 "description": "",
                 "operationId": "BrokersBase_getOwnedNamespaces",
@@ -5406,7 +5410,7 @@
                     },
                     {
                         "in": "path",
-                        "name": "broker-webserviceurl",
+                        "name": "brokerId",
                         "required": true,
                         "type": "string"
                     }
@@ -5434,7 +5438,7 @@
                         "description": "Cluster doesn't exist"
                     }
                 },
-                "summary": "Get the list of namespaces served by the specific broker",
+                "summary": "Get the list of namespaces served by the specific broker id",
                 "tags": [
                     "brokers"
                 ]
@@ -5479,7 +5483,7 @@
                         "description": "Cluster does not exist: cluster={clustername}"
                     }
                 },
-                "summary": "Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid.",
+                "summary": "Get the list of active brokers (broker ids) in the cluster.If authorization is not enabled, any cluster name is valid.",
                 "tags": [
                     "brokers"
                 ]
@@ -7913,6 +7917,122 @@
                 ]
             }
         },
+        "/namespaces/{tenant}/{namespace}/dispatcherPauseOnAckStatePersistent": {
+            "delete": {
+                "consumes": [
+                    "application/json"
+                ],
+                "description": "",
+                "operationId": "Namespaces_removeDispatcherPauseOnAckStatePersistent",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "tenant",
+                        "required": true,
+                        "type": "string"
+                    },
+                    {
+                        "in": "path",
+                        "name": "namespace",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "responses": {
+                    "403": {
+                        "description": "Don't have admin permission"
+                    },
+                    "404": {
+                        "description": "Tenant or cluster or namespace doesn't exist"
+                    },
+                    "409": {
+                        "description": "Concurrent modification"
+                    }
+                },
+                "summary": "Remove dispatcher pause on ack state persistent configuration for specified namespace.",
+                "tags": [
+                    "namespaces"
+                ]
+            },
+            "get": {
+                "consumes": [
+                    "application/json"
+                ],
+                "description": "",
+                "operationId": "Namespaces_getDispatcherPauseOnAckStatePersistent",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "tenant",
+                        "required": true,
+                        "type": "string"
+                    },
+                    {
+                        "in": "path",
+                        "name": "namespace",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "responses": {
+                    "403": {
+                        "description": "Don't have admin permission"
+                    },
+                    "404": {
+                        "description": "Tenant or cluster or namespace doesn't exist"
+                    }
+                },
+                "summary": "Get dispatcher pause on ack state persistent config on a namespace.",
+                "tags": [
+                    "namespaces"
+                ]
+            },
+            "post": {
+                "consumes": [
+                    "application/json"
+                ],
+                "description": "",
+                "operationId": "Namespaces_setDispatcherPauseOnAckStatePersistent",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "tenant",
+                        "required": true,
+                        "type": "string"
+                    },
+                    {
+                        "in": "path",
+                        "name": "namespace",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "responses": {
+                    "403": {
+                        "description": "Don't have admin permission"
+                    },
+                    "404": {
+                        "description": "Tenant or cluster or namespace doesn't exist"
+                    },
+                    "409": {
+                        "description": "Concurrent modification"
+                    }
+                },
+                "summary": "Set dispatcher pause on ack state persistent configuration for specified namespace.",
+                "tags": [
+                    "namespaces"
+                ]
+            }
+        },
         "/namespaces/{tenant}/{namespace}/encryptionRequired": {
             "get": {
                 "consumes": [
diff --git a/static/swagger/master/v2/swagger.json b/static/swagger/master/v2/swagger.json
index 80b27eeb4f36..bef13a82c774 100644
--- a/static/swagger/master/v2/swagger.json
+++ b/static/swagger/master/v2/swagger.json
@@ -1345,22 +1345,23 @@
                     "format": "int64",
                     "type": "integer"
                 },
+                "isOffloaded": {
+                    "type": "boolean"
+                },
                 "ledgerId": {
                     "format": "int64",
                     "type": "integer"
                 },
-                "metadata": {
+                "offloadedContextUuid": {
                     "type": "string"
                 },
-                "offloaded": {
-                    "type": "boolean"
-                },
                 "size": {
                     "format": "int64",
                     "type": "integer"
                 },
-                "underReplicated": {
-                    "type": "boolean"
+                "timestamp": {
+                    "format": "int64",
+                    "type": "integer"
                 }
             },
             "type": "object"
@@ -3122,6 +3123,9 @@
                 "deleted": {
                     "type": "boolean"
                 },
+                "dispatcherPauseOnAckStatePersistentEnabled": {
+                    "type": "boolean"
+                },
                 "encryption_required": {
                     "type": "boolean"
                 },
@@ -5045,7 +5049,7 @@
                         "description": "This operation requires super-user access"
                     }
                 },
-                "summary": "Get the list of active brokers (web service addresses) in the local cluster.If authorization is not enabled",
+                "summary": "Get the list of active brokers (broker ids) in the local cluster.If authorization is not enabled",
                 "tags": [
                     "brokers"
                 ]
@@ -5393,7 +5397,7 @@
                 ]
             }
         },
-        "/brokers/{clusterName}/{broker-webserviceurl}/ownedNamespaces": {
+        "/brokers/{clusterName}/{brokerId}/ownedNamespaces": {
             "get": {
                 "description": "",
                 "operationId": "BrokersBase_getOwnedNamespaces",
@@ -5406,7 +5410,7 @@
                     },
                     {
                         "in": "path",
-                        "name": "broker-webserviceurl",
+                        "name": "brokerId",
                         "required": true,
                         "type": "string"
                     }
@@ -5434,7 +5438,7 @@
                         "description": "Cluster doesn't exist"
                     }
                 },
-                "summary": "Get the list of namespaces served by the specific broker",
+                "summary": "Get the list of namespaces served by the specific broker id",
                 "tags": [
                     "brokers"
                 ]
@@ -5479,7 +5483,7 @@
                         "description": "Cluster does not exist: cluster={clustername}"
                     }
                 },
-                "summary": "Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid.",
+                "summary": "Get the list of active brokers (broker ids) in the cluster.If authorization is not enabled, any cluster name is valid.",
                 "tags": [
                     "brokers"
                 ]
@@ -7913,6 +7917,122 @@
                 ]
             }
         },
+        "/namespaces/{tenant}/{namespace}/dispatcherPauseOnAckStatePersistent": {
+            "delete": {
+                "consumes": [
+                    "application/json"
+                ],
+                "description": "",
+                "operationId": "Namespaces_removeDispatcherPauseOnAckStatePersistent",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "tenant",
+                        "required": true,
+                        "type": "string"
+                    },
+                    {
+                        "in": "path",
+                        "name": "namespace",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "responses": {
+                    "403": {
+                        "description": "Don't have admin permission"
+                    },
+                    "404": {
+                        "description": "Tenant or cluster or namespace doesn't exist"
+                    },
+                    "409": {
+                        "description": "Concurrent modification"
+                    }
+                },
+                "summary": "Remove dispatcher pause on ack state persistent configuration for specified namespace.",
+                "tags": [
+                    "namespaces"
+                ]
+            },
+            "get": {
+                "consumes": [
+                    "application/json"
+                ],
+                "description": "",
+                "operationId": "Namespaces_getDispatcherPauseOnAckStatePersistent",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "tenant",
+                        "required": true,
+                        "type": "string"
+                    },
+                    {
+                        "in": "path",
+                        "name": "namespace",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "responses": {
+                    "403": {
+                        "description": "Don't have admin permission"
+                    },
+                    "404": {
+                        "description": "Tenant or cluster or namespace doesn't exist"
+                    }
+                },
+                "summary": "Get dispatcher pause on ack state persistent config on a namespace.",
+                "tags": [
+                    "namespaces"
+                ]
+            },
+            "post": {
+                "consumes": [
+                    "application/json"
+                ],
+                "description": "",
+                "operationId": "Namespaces_setDispatcherPauseOnAckStatePersistent",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "tenant",
+                        "required": true,
+                        "type": "string"
+                    },
+                    {
+                        "in": "path",
+                        "name": "namespace",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "responses": {
+                    "403": {
+                        "description": "Don't have admin permission"
+                    },
+                    "404": {
+                        "description": "Tenant or cluster or namespace doesn't exist"
+                    },
+                    "409": {
+                        "description": "Concurrent modification"
+                    }
+                },
+                "summary": "Set dispatcher pause on ack state persistent configuration for specified namespace.",
+                "tags": [
+                    "namespaces"
+                ]
+            }
+        },
         "/namespaces/{tenant}/{namespace}/encryptionRequired": {
             "get": {
                 "consumes": [