merlimat closed pull request #2174: V2 doc changes
URL: https://github.com/apache/incubator-pulsar/pull/2174
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/site/docs/latest/admin-api/brokers.md
b/site/docs/latest/admin-api/brokers.md
index 55bbe80cf3..0c334e214b 100644
--- a/site/docs/latest/admin-api/brokers.md
+++ b/site/docs/latest/admin-api/brokers.md
@@ -31,7 +31,7 @@ Pulsar brokers consist of two components:
{% popover Brokers %} can be managed via:
* The [`brokers`](../../reference/CliTools#pulsar-admin-brokers) command of
the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) tool
-* The `/admin/brokers` endpoint of the admin [REST
API](../../reference/RestApi)
+* The `/admin/v2/brokers` endpoint of the admin [REST
API](../../reference/RestApi)
* The `brokers` method of the {% javadoc PulsarAdmin admin
org.apache.pulsar.client.admin.PulsarAdmin %} object in the [Java
API](../../clients/Java)
In addition to being configurable when you start them up, brokers can also be
[dynamically configured](#dynamic-broker-configuration).
@@ -44,7 +44,7 @@ See the [Configuration](../../reference/Configuration#broker)
page for a full li
### List active brokers
-Fetch all available active brokers that are serving traffic.
+Fetch all available active brokers that are serving traffic.
#### pulsar-admin
@@ -59,7 +59,7 @@ broker1.use.org.com:8080
###### REST
-{% endpoint GET /admin/brokers/:cluster %}
+{% endpoint GET /admin/v2/brokers/:cluster %}
[More info](../../reference/RestApi#/admin/brokers/:cluster)
@@ -71,7 +71,7 @@ admin.brokers().getActiveBrokers(clusterName)
#### list of namespaces owned by a given broker
-It finds all namespaces which are owned and served by a given broker.
+It finds all namespaces which are owned and served by a given broker.
###### CLI
@@ -91,7 +91,7 @@ $ pulsar-admin brokers namespaces use \
```
###### REST
-{% endpoint GET /admin/brokers/:cluster/:broker:/ownedNamespaces %}
+{% endpoint GET /admin/v2/brokers/:cluster/:broker:/ownedNamespaces %}
###### Java
@@ -106,7 +106,7 @@ One way to configure a Pulsar {% popover broker %} is to
supply a [configuration
But since all broker configuration in Pulsar is stored in {% popover ZooKeeper
%}, configuration values can also be dynamically updated *while the broker is
running*. When you update broker configuration dynamically, ZooKeeper will
notify the broker of the change and the broker will then override any existing
configuration values.
* The [`brokers`](../../reference/CliTools#pulsar-admin-brokers) command for
the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) tool has a variety
of subcommands that enable you to manipulate a broker's configuration
dynamically, enabling you to [update config
values](#update-dynamic-configuration) and more.
-* In the Pulsar admin [REST API](../../reference/RestApi), dynamic
configuration is managed through the `/admin/brokers/configuration` endpoint.
+* In the Pulsar admin [REST API](../../reference/RestApi), dynamic
configuration is managed through the `/admin/v2/brokers/configuration` endpoint.
### Update dynamic configuration
@@ -120,7 +120,7 @@ $ pulsar-admin brokers update-dynamic-config
brokerShutdownTimeoutMs 100
#### REST API
-{% endpoint POST /admin/brokers/configuration/:configName/:configValue %}
+{% endpoint POST /admin/v2/brokers/configuration/:configName/:configValue %}
[More
info](../../reference/RestApi#/admin/brokers/configuration/:configName/:configValue)
@@ -143,7 +143,7 @@ brokerShutdownTimeoutMs
#### REST API
-{% endpoint GET /admin/brokers/configuration %}
+{% endpoint GET /admin/v2/brokers/configuration %}
[More info](../../reference/RestApi#/admin/brokers/configuration)
@@ -166,7 +166,7 @@ brokerShutdownTimeoutMs:100
#### REST API
-{% endpoint GET /admin/brokers/configuration/values %}
+{% endpoint GET /admin/v2/brokers/configuration/values %}
[More info](../../reference/RestApi#/admin/brokers/configuration/values)
diff --git a/site/docs/latest/admin-api/clusters.md
b/site/docs/latest/admin-api/clusters.md
index e04d680fc5..65b36d8902 100644
--- a/site/docs/latest/admin-api/clusters.md
+++ b/site/docs/latest/admin-api/clusters.md
@@ -28,7 +28,7 @@ Pulsar clusters consist of one or more Pulsar {% popover
brokers %}, one or more
Clusters can be managed via:
* The [`clusters`](../../reference/CliTools#pulsar-admin-clusters) command of
the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) tool
-* The `/admin/clusters` endpoint of the admin [REST
API](../../reference/RestApi)
+* The `/admin/v2/clusters` endpoint of the admin [REST
API](../../reference/RestApi)
* The `clusters` method of the {% javadoc PulsarAdmin admin
org.apache.pulsar.client.admin.PulsarAdmin %} object in the [Java
API](../../clients/Java)
## Clusters resources
@@ -51,7 +51,7 @@ $ pulsar-admin clusters create cluster-1 \
#### REST API
-{% endpoint PUT /admin/clusters/:cluster %}
+{% endpoint PUT /admin/v2/clusters/:cluster %}
[More info](../../reference/RestApi#/admin/clusters/:cluster)
@@ -119,7 +119,7 @@ $ pulsar-admin clusters get cluster-1
#### REST API
-{% endpoint GET /admin/clusters/:cluster %}
+{% endpoint GET /admin/v2/clusters/:cluster %}
[More info](../../reference/RestApi#/admin/clusters/:cluster)
@@ -145,7 +145,7 @@ $ pulsar-admin clusters update cluster-1 \
#### REST
-{% endpoint POST /admin/clusters/:cluster %}
+{% endpoint POST /admin/v2/clusters/:cluster %}
[More info](../../reference/RestApi#/admin/clusters/:cluster)
@@ -175,7 +175,7 @@ $ pulsar-admin clusters delete cluster-1
#### REST API
-{% endpoint DELETE /admin/clusters/:cluster %}
+{% endpoint DELETE /admin/v2/clusters/:cluster %}
[More info](../../reference/RestApi#/admin/clusters/:cluster)
@@ -201,7 +201,7 @@ cluster-2
#### REST API
-{% endpoint GET /admin/clusters %}
+{% endpoint GET /admin/v2/clusters %}
[More info](../../reference/RestApi#/admin/clusters)
@@ -225,7 +225,7 @@ $ pulsar-admin update-peer-clusters cluster-1
--peer-clusters cluster-2
#### REST API
-{% endpoint POST /admin/clusters/:cluster/peers %}
+{% endpoint POST /admin/v2/clusters/:cluster/peers %}
[More info](../../reference/RestApi#/admin/clusters/:cluster/peers)
diff --git a/site/docs/latest/admin-api/namespaces.md
b/site/docs/latest/admin-api/namespaces.md
index 18393c096d..33de1e2eac 100644
--- a/site/docs/latest/admin-api/namespaces.md
+++ b/site/docs/latest/admin-api/namespaces.md
@@ -28,7 +28,7 @@ Pulsar {% popover namespaces %} are logical groupings of {%
popover topics %}.
Namespaces can be managed via:
* The [`namespaces`](../../reference/CliTools#pulsar-admin-clusters) command
of the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) tool
-* The `/admin/namespaces` endpoint of the admin [REST
API](../../reference/RestApi)
+* The `/admin/v2/namespaces` endpoint of the admin [REST
API](../../reference/RestApi)
* The `namespaces` method of the {% javadoc PulsarAdmin admin
org.apache.pulsar.client.admin.PulsarAdmin %} object in the [Java
API](../../applications/JavaClient)
## Namespaces resources
@@ -47,9 +47,9 @@ $ pulsar-admin namespaces create test-tenant/test-namespace
#### REST API
-{% endpoint PUT /admin/namespaces/:tenant/:cluster/:namespace %}
+{% endpoint PUT /admin/v2/namespaces/:tenant/:namespace %}
-[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:cluster/:namespace)
+[More info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace)
#### Java
@@ -92,9 +92,9 @@ $ pulsar-admin namespaces policies test-tenant/test-namespace
#### REST API
-{% endpoint GET /admin/namespaces/:tenant/:cluster/:namespace %}
+{% endpoint GET /admin/v2/namespaces/:tenant/:namespace %}
-[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:cluster/:namespace)
+[More info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace)
#### Java
@@ -118,7 +118,7 @@ test-tenant/ns2
#### REST API
-{% endpoint GET /admin/namespaces/:tenant %}
+{% endpoint GET /admin/v2/namespaces/:tenant %}
[More info](../../reference/RestApi#/admin/namespaces/:tenant)
@@ -128,32 +128,6 @@ test-tenant/ns2
admin.namespaces().getNamespaces(tenant);
```
-### List namespaces within a cluster
-
-You can list all namespaces within a given Pulsar {% popover cluster %}.
-
-#### pulsar-admin
-
-Use the
[`list-cluster`](../../reference/CliTools#pulsar-admin-namespaces-list-cluster)
subcommand and specify the cluster:
-
-```shell
-$ pulsar-admin namespaces list-cluster test-tenant/cl1
-test-tenant/ns1
-test-tenant/ns2
-```
-
-#### REST API
-
-{% endpoint GET /admin/namespaces/:tenant/:cluster %}
-
-[More info](../../reference/RestApi#/admin/namespaces/:tenant/:cluster)
-
-#### Java
-
-```java
-admin.namespaces().getNamespaces(tenant);
-```
-
### Delete
You can delete existing namespaces from a tenant.
@@ -168,9 +142,9 @@ $ pulsar-admin namespaces delete test-tenant/ns1
#### REST
-{% endpoint DELETE /admin/namespaces/:tenant/:cluster/:namespace %}
+{% endpoint DELETE /admin/v2/namespaces/:tenant/:namespace %}
-[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:cluster/:namespace)
+[More info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace)
#### Java
@@ -193,7 +167,7 @@ $ pulsar-admin namespaces set-clusters test-tenant/ns1 \
###### REST
```
-{% endpoint POST /admin/namespaces/:tenant/:namespace/replication %}
+{% endpoint POST /admin/v2/namespaces/:tenant/:namespace/replication %}
```
###### Java
@@ -219,7 +193,7 @@ cl2
###### REST
```
-GET /admin/namespaces/{tenant}/{namespace}/replication
+GET /admin/v2/namespaces/{tenant}/{namespace}/replication
```
###### Java
@@ -238,7 +212,7 @@ Backlog quota helps broker to restrict bandwidth/storage of
a namespace once it
3. consumer_backlog_eviction: broker will start discarding backlog messages
- Backlog quota restriction can be taken care by defining restriction of
backlog-quota-type: destination_storage
+ Backlog quota restriction can be taken care by defining restriction of
backlog-quota-type: destination_storage
###### CLI
@@ -253,7 +227,7 @@ N/A
###### REST
```
-POST /admin/namespaces/{tenant}/{namespace}/backlogQuota
+POST /admin/v2/namespaces/{tenant}/{namespace}/backlogQuota
```
###### Java
@@ -278,13 +252,13 @@ $ pulsar-admin namespaces get-backlog-quotas
test-tenant/ns1
"limit": 10,
"policy": "producer_request_hold"
}
-}
+}
```
###### REST
```
-GET /admin/namespaces/{tenant}/{namespace}/backlogQuotaMap
+GET /admin/v2/namespaces/{tenant}/{namespace}/backlogQuotaMap
```
###### Java
@@ -295,7 +269,7 @@ admin.namespaces().getBacklogQuotaMap(namespace);
#### remove backlog quota policies
-It removes backlog quota policies for a given namespace
+It removes backlog quota policies for a given namespace
###### CLI
@@ -310,7 +284,7 @@ N/A
###### REST
```
-DELETE /admin/namespaces/{tenant}/{namespace}/backlogQuota
+DELETE /admin/v2/namespaces/{tenant}/{namespace}/backlogQuota
```
###### Java
@@ -329,7 +303,7 @@ Persistence policies allow to configure persistency-level
for all topic messages
- Bookkeeper-write-quorum: How many writes to make of each entry, default: 0
- - Ml-mark-delete-max-rate: Throttling rate of mark-delete operation (0
means no throttle), default: 0.0
+ - Ml-mark-delete-max-rate: Throttling rate of mark-delete operation (0
means no throttle), default: 0.0
###### CLI
@@ -344,7 +318,7 @@ N/A
###### REST
```
-POST /admin/persistent/{tenant}/{namespace}/persistence
+POST /admin/v2/namespaces/{tenant}/{namespace}/persistence
```
###### Java
@@ -356,7 +330,7 @@ admin.namespaces().setPersistence(namespace,new
PersistencePolicies(bookkeeperEn
#### get persistence policies
-It shows configured persistence policies of a given namespace.
+It shows configured persistence policies of a given namespace.
###### CLI
@@ -376,7 +350,7 @@ $ pulsar-admin namespaces get-persistence test-tenant/ns1
###### REST
```
-GET /admin/namespaces/{tenant}/{namespace}/persistence
+GET /admin/v2/namespaces/{tenant}/{namespace}/persistence
```
###### Java
@@ -388,7 +362,7 @@ admin.namespaces().getPersistence(namespace)
#### unload namespace bundle
-Namespace bundle is a virtual group of topics which belong to same namespace.
If broker gets overloaded with number of bundles then this command can help to
unload heavy bundle from that broker, so it can be served by some other less
loaded broker. Namespace bundle is defined with it’s start and end range such
as 0x00000000 and 0xffffffff.
+Namespace bundle is a virtual group of topics which belong to same namespace.
If broker gets overloaded with number of bundles then this command can help to
unload heavy bundle from that broker, so it can be served by some other less
loaded broker. Namespace bundle is defined with it’s start and end range such
as 0x00000000 and 0xffffffff.
###### CLI
@@ -403,7 +377,7 @@ N/A
###### REST
```
-PUT /admin/namespaces/{tenant}/{namespace}/unload
+PUT /admin/v2/namespaces/{tenant}/{namespace}/unload
```
###### Java
@@ -430,7 +404,7 @@ N/A
###### REST
```
-POST /admin/namespaces/{tenant}/{namespace}/messageTTL
+POST /admin/v2/namespaces/{tenant}/{namespace}/messageTTL
```
###### Java
@@ -457,7 +431,7 @@ $ pulsar-admin namespaces get-message-ttl test-tenant/ns1
###### REST
```
-GET /admin/namespaces/{tenant}/{namespace}/messageTTL
+GET /admin/v2/namespaces/{tenant}/{namespace}/messageTTL
```
###### Java
@@ -484,7 +458,7 @@ N/A
###### REST
```
-PUT /admin/namespaces/{tenant}/{namespace}/{bundle}/split
+PUT /admin/v2/namespaces/{tenant}/{namespace}/{bundle}/split
```
###### Java
@@ -496,7 +470,7 @@ admin.namespaces().splitNamespaceBundle(namespace, bundle)
#### clear backlog
-It clears all message backlog for all the topics those belong to specific
namespace. You can also clear backlog for a specific subscription as well.
+It clears all message backlog for all the topics those belong to specific
namespace. You can also clear backlog for a specific subscription as well.
###### CLI
@@ -511,7 +485,7 @@ N/A
###### REST
```
-POST /admin/namespaces/{tenant}/{namespace}/clearBacklog
+POST /admin/v2/namespaces/{tenant}/{namespace}/clearBacklog
```
###### Java
@@ -523,7 +497,7 @@
admin.namespaces().clearNamespaceBacklogForSubscription(namespace, subscription)
#### clear bundle backlog
-It clears all message backlog for all the topics those belong to specific
NamespaceBundle. You can also clear backlog for a specific subscription as
well.
+It clears all message backlog for all the topics those belong to specific
NamespaceBundle. You can also clear backlog for a specific subscription as well.
###### CLI
@@ -538,7 +512,7 @@ N/A
###### REST
```
-POST /admin/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog
+POST /admin/v2/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog
```
###### Java
@@ -565,7 +539,7 @@ N/A
###### REST
```
-POST /admin/namespaces/{tenant}/{namespace}/retention
+POST /admin/v2/namespaces/{tenant}/{namespace}/retention
```
###### Java
@@ -595,7 +569,7 @@ $ pulsar-admin namespaces get-retention test-tenant/ns1
###### REST
```
-GET /admin/namespaces/{tenant}/{namespace}/retention
+GET /admin/v2/namespaces/{tenant}/{namespace}/retention
```
###### Java
@@ -606,9 +580,9 @@ admin.namespaces().getRetention(namespace)
#### set dispatch throttling
-It sets message dispatch rate for all the topics under a given namespace.
-Dispatch rate can be restricted by number of message per X seconds
(`msg-dispatch-rate`) or by number of message-bytes per X second
(`byte-dispatch-rate`).
-dispatch rate is in second and it can be configured with
`dispatch-rate-period`. Default value of `msg-dispatch-rate` and
`byte-dispatch-rate` is -1 which
+It sets message dispatch rate for all the topics under a given namespace.
+Dispatch rate can be restricted by number of message per X seconds
(`msg-dispatch-rate`) or by number of message-bytes per X second
(`byte-dispatch-rate`).
+dispatch rate is in second and it can be configured with
`dispatch-rate-period`. Default value of `msg-dispatch-rate` and
`byte-dispatch-rate` is -1 which
disables the throttling.
###### CLI
@@ -623,7 +597,7 @@ $ pulsar-admin namespaces set-dispatch-rate test-tenant/ns1
\
###### REST
```
-POST /admin/namespaces/{tenant}/{namespace}/dispatchRate
+POST /admin/v2/namespaces/{tenant}/{namespace}/dispatchRate
```
###### Java
@@ -634,7 +608,7 @@ admin.namespaces().setDispatchRate(namespace, 1000,
1048576, 1)
#### get configured message-rate
-It shows configured message-rate for the namespace (topics under this
namespace can dispatch this many messages per second)
+It shows configured message-rate for the namespace (topics under this
namespace can dispatch this many messages per second)
###### CLI
@@ -653,7 +627,7 @@ $ pulsar-admin namespaces get-dispatch-rate test-tenant/ns1
###### REST
```
-GET /admin/namespaces/{tenant}/{namespace}/dispatchRate
+GET /admin/v2/namespaces/{tenant}/{namespace}/dispatchRate
```
###### Java
diff --git a/site/docs/latest/admin-api/non-persistent-topics.md
b/site/docs/latest/admin-api/non-persistent-topics.md
index ad95de6e68..59200c3112 100644
--- a/site/docs/latest/admin-api/non-persistent-topics.md
+++ b/site/docs/latest/admin-api/non-persistent-topics.md
@@ -141,7 +141,7 @@ $ pulsar-admin non-persistent stats \
#### REST API
-{% endpoint GET /admin/non-persistent/:tenant/:namespace/:destination/stats %}
+{% endpoint GET /admin/v2/non-persistent/:tenant/:namespace/:destination/stats
%}
#### Java
@@ -182,7 +182,7 @@ $ pulsar-admin non-persistent stats-internal \
#### REST API
-{% endpoint GET
/admin/non-persistent/:tenant/:namespace/:destination/internalStats %}
+{% endpoint GET
/admin/v2/non-persistent/:tenant/:namespace/:destination/internalStats %}
#### Java
@@ -206,7 +206,7 @@ $ bin/pulsar-admin non-persistent create-partitioned-topic \
#### REST API
-{% endpoint PUT
/admin/non-persistent/:tenant/:namespace/:destination/partitions %}
+{% endpoint PUT
/admin/v2/non-persistent/:tenant/:namespace/:destination/partitions %}
#### Java
@@ -236,7 +236,7 @@ $ pulsar-admin non-persistent
get-partitioned-topic-metadata \
#### REST API
-{% endpoint GET
/admin/non-persistent/:tenant/:namespace/:destination/partitions %}
+{% endpoint GET
/admin/v2/non-persistent/:tenant/:namespace/:destination/partitions %}
#### Java
@@ -261,7 +261,7 @@ $ pulsar-admin non-persistent unload \
#### REST API
-{% endpoint PUT /admin/non-persistent/:tenant/:namespace/:destination/unload %}
+{% endpoint PUT
/admin/v2/non-persistent/:tenant/:namespace/:destination/unload %}
[More
info](../../reference/RestApi#/admin/non-persistent/:tenant/:namespace/:destination/unload)
diff --git a/site/docs/latest/admin-api/persistent-topics.md
b/site/docs/latest/admin-api/persistent-topics.md
index 4dbd73b664..4a872da4f8 100644
--- a/site/docs/latest/admin-api/persistent-topics.md
+++ b/site/docs/latest/admin-api/persistent-topics.md
@@ -46,7 +46,7 @@ $ pulsar-admin persistent list \
#### REST API
-{% endpoint GET /admin/persistent/:tenant/:namespace %}
+{% endpoint GET /admin/v2/persistent/:tenant/:namespace %}
[More info](../../reference/RestApi#/admin/persistent/:tenant/:namespace)
@@ -74,7 +74,7 @@ $ pulsar-admin persistent grant-permission \
#### REST API
-{% endpoint POST /admin/namespaces/:tenant/:namespace/permissions/:role %}
+{% endpoint POST /admin/v2/namespaces/:tenant/:namespace/permissions/:role %}
[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/permissions/:role)
@@ -107,7 +107,7 @@ $ pulsar-admin persistent permissions \
#### REST API
-{% endpoint GET /admin/namespaces/:tenant/:namespace/permissions %}
+{% endpoint GET /admin/v2/namespaces/:tenant/:namespace/permissions %}
[More
info](../../reference/RestApi#/admin/namespaces/:tenant:namespace/permissions)
@@ -141,7 +141,7 @@ $ pulsar-admin persistent revoke-permission \
#### REST API
-{% endpoint DELETE /admin/namespaces/:tenant:namespace/permissions/:role %}
+{% endpoint DELETE /admin/v2/namespaces/:tenant:namespace/permissions/:role %}
[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/permissions/:role)
@@ -168,7 +168,7 @@ $ pulsar-admin persistent delete \
#### REST API
-{% endpoint DELETE /admin/persistent/:tenant/:namespace/:destination %}
+{% endpoint DELETE /admin/v2/persistent/:tenant/:namespace/:destination %}
[More
info](../../reference/RestApi#/admin/persistent/:tenant/:namespace/:destination)
@@ -194,7 +194,7 @@ $ pulsar-admin persistent unload \
#### REST API
-{% endpoint PUT /admin/persistent/:tenant/:namespace/:destination/unload %}
+{% endpoint PUT /admin/v2/persistent/:tenant/:namespace/:destination/unload %}
[More
info](../../reference/RestApi#/admin/persistent/:tenant/:namespace/:destination/unload)
@@ -305,7 +305,7 @@ $ pulsar-admin persistent stats \
#### REST API
-{% endpoint GET /admin/persistent/:tenant/:namespace/:destination/stats %}
+{% endpoint GET /admin/v2/persistent/:tenant/:namespace/:destination/stats %}
[More
info](../../reference/RestApi#/admin/persistent/:tenant:namespace/:destination/stats)
@@ -415,7 +415,7 @@ $ pulsar-admin persistent stats-internal \
#### REST API
-{% endpoint GET
/admin/persistent/:tenant/:namespace/:destination/internalStats %}
+{% endpoint GET
/admin/v2/persistent/:tenant/:namespace/:destination/internalStats %}
[More
info](../../reference/RestApi#/admin/persistent/:tenant/:namespace/:destination/internalStats)
@@ -445,7 +445,7 @@ msg-payload
#### REST API
-{% endpoint GET
/admin/persistent/:tenant/:namespace/:destination/subscription/:subName/position/:messagePosition
%}
+{% endpoint GET
/admin/v2/persistent/:tenant/:namespace/:destination/subscription/:subName/position/:messagePosition
%}
[More
info](../../reference/RestApi#/admin/persistent/:tenant/:namespace/:destination/subscription/:subName/position/:messagePosition)
@@ -473,7 +473,7 @@ $ pulsar-admin persistent skip \
#### REST API
-{% endpoint POST
/admin/persistent/:tenant/:namespace/:destination/subscription/:subName/skip/:numMessages
%}
+{% endpoint POST
/admin/v2/persistent/:tenant/:namespace/:destination/subscription/:subName/skip/:numMessages
%}
[More
info](../../reference/RestApi#/admin/persistent/:tenant/:namespace/:destination/subscription/:subName/skip/:numMessages)
@@ -501,7 +501,7 @@ $ pulsar-admin persistent skip-all \
#### REST API
-{% endpoint POST
/admin/persistent/:tenant/:namespace/:destination/subscription/:subName/skip_all
%}
+{% endpoint POST
/admin/v2/persistent/:tenant/:namespace/:destination/subscription/:subName/skip_all
%}
[More
info](../../reference/RestApi#/admin/persistent/:tenant/:namespace/:destination/subscription/:subName/skip_all)
@@ -528,7 +528,7 @@ $ pulsar-admin persistent reset-cursor \
#### REST API
-{% endpoint POST
/admin/persistent/:tenant/:namespace/:destination/subscription/:subName/resetcursor/:timestamp
%}
+{% endpoint POST
/admin/v2/persistent/:tenant/:namespace/:destination/subscription/:subName/resetcursor/:timestamp
%}
[More
info](../../reference/RestApi#/admin/persistent/:tenant/:namespace/:destination/subscription/:subName/resetcursor/:timestamp)
@@ -566,7 +566,7 @@ String destination =
"persistent://my-tenant/my-namespace/my-topic";
admin.lookup().lookupDestination(destination);
```
-### Get bundle
+### Get bundle
It gives range of the bundle which contains given topic
@@ -607,7 +607,7 @@ $ pulsar-admin persistent subscriptions \
#### REST API
-{% endpoint GET
/admin/persistent/:tenant/:namespace/:destination/subscriptions %}
+{% endpoint GET
/admin/v2/persistent/:tenant/:namespace/:destination/subscriptions %}
[More
info](../../reference/RestApi#/admin/persistent/:tenant/:namespace/:destination/subscriptions)
@@ -633,7 +633,7 @@ $ pulsar-admin persistent unsubscribe \
#### REST API
-{% endpoint POST
/admin/namespaces/:tenant/:namespace/unsubscribe/:subscription %}
+{% endpoint POST
/admin/v2/namespaces/:tenant/:namespace/unsubscribe/:subscription %}
[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/unsubscribe/:subscription)
diff --git a/site/docs/latest/admin/ZooKeeperBookKeeper.md
b/site/docs/latest/admin/ZooKeeperBookKeeper.md
index 1d673599d0..f2470a2a9b 100644
--- a/site/docs/latest/admin/ZooKeeperBookKeeper.md
+++ b/site/docs/latest/admin/ZooKeeperBookKeeper.md
@@ -122,9 +122,9 @@ $ pulsar-admin namespaces set-persistence
my-prop/my-cluster/my-ns \
#### REST API
-{% endpoint POST /admin/namespaces/:property/:cluster/:namespace/persistence %}
+{% endpoint POST /admin/v2/namespaces/:tenant/:namespace/persistence %}
-[More
info](../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace/persistence)
+[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/persistence)
#### Java
@@ -160,9 +160,9 @@ $ pulsar-admin namespaces get-persistence
my-prop/my-cluster/my-ns
#### REST API
-{% endpoint GET /admin/namespaces/:property/:cluster/:namespace/persistence %}
+{% endpoint GET /admin/v2/namespaces/:tenant/:namespace/persistence %}
-[More
info](../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace/persistence)
+[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/persistence)
#### Java
diff --git a/site/docs/latest/clients/WebSocket.md
b/site/docs/latest/clients/WebSocket.md
index 8ba6d8606c..06c259fbf3 100644
--- a/site/docs/latest/clients/WebSocket.md
+++ b/site/docs/latest/clients/WebSocket.md
@@ -79,7 +79,7 @@ All exchanges via the WebSocket API use JSON.
The producer endpoint requires you to specify a {% popover tenant %}, {%
popover namespace %}, and {% popover topic %} in the URL:
-{% endpoint
ws://broker-service-url:8080/ws/producer/persistent/:tenant/:namespace/:topic %}
+{% endpoint
ws://broker-service-url:8080/ws/v2/producer/persistent/:tenant/:namespace/:topic
%}
##### Query param
@@ -146,7 +146,7 @@ Key | Type | Required? | Explanation
The consumer endpoint requires you to specify a {% popover tenant %}, {%
popover namespace %}, and {% popover topic %}, as well as a {% popover
subscription %}, in the URL:
-{% endpoint
ws://broker-service-url:8080/ws/consumer/persistent/:tenant/:namespace/:topic/:subscription
%}
+{% endpoint
ws://broker-service-url:8080/ws/v2/consumer/persistent/:tenant/:namespace/:topic/:subscription
%}
##### Query param
@@ -199,7 +199,7 @@ Key | Type | Required? | Explanation
The reader endpoint requires you to specify a {% popover tenant %}, {% popover
namespace %}, and {% popover topic %} in the URL:
-{% endpoint
ws://broker-service-url:8080/ws/reader/persistent/:tenant/:namespace/:topic %}
+{% endpoint
ws://broker-service-url:8080/ws/v2/reader/persistent/:tenant/:namespace/:topic
%}
##### Query param
@@ -286,7 +286,7 @@ Here's an example Python {% popover producer %} that sends
a simple message to a
```python
import websocket, base64, json
-TOPIC = 'ws://localhost:8080/ws/producer/persistent/public/default/my-topic'
+TOPIC = 'ws://localhost:8080/ws/v2/producer/persistent/public/default/my-topic'
ws = websocket.create_connection(TOPIC)
@@ -315,7 +315,7 @@ Here's an example Python {% popover consumer %} that
listens on a Pulsar {% popo
```python
import websocket, base64, json
-TOPIC =
'ws://localhost:8080/ws/consumer/persistent/public/default/my-topic/my-sub'
+TOPIC =
'ws://localhost:8080/ws/v2/consumer/persistent/public/default/my-topic/my-sub'
ws = websocket.create_connection(TOPIC)
@@ -338,7 +338,7 @@ Here's an example Python reader that listens on a Pulsar {%
popover topic %} and
```python
import websocket, base64, json
-TOPIC = 'ws://localhost:8080/ws/reader/persistent/public/default/my-topic'
+TOPIC = 'ws://localhost:8080/ws/v2/reader/persistent/public/default/my-topic'
ws = websocket.create_connection(TOPIC)
@@ -368,7 +368,7 @@ Here's an example Node.js {% popover producer %} that sends
a simple message to
```javascript
var WebSocket = require('ws'),
- topic =
"ws://localhost:8080/ws/producer/persistent/my-tenant/my-ns/my-topic1",
+ topic =
"ws://localhost:8080/ws/v2/producer/persistent/my-tenant/my-ns/my-topic1",
ws = new WebSocket(topic);
var message = {
@@ -396,7 +396,7 @@ Here's an example Node.js {% popover consumer %} that
listens on the same topic
```javascript
var WebSocket = require('ws'),
- topic =
"ws://localhost:8080/ws/consumer/persistent/my-tenant/my-ns/my-topic1/my-sub",
+ topic =
"ws://localhost:8080/ws/v2/consumer/persistent/my-tenant/my-ns/my-topic1/my-sub",
ws = new WebSocket(topic);
ws.on('message', function(message) {
@@ -410,7 +410,7 @@ ws.on('message', function(message) {
#### NodeJS reader
```javascript
var WebSocket = require('ws'),
- topic =
"ws://localhost:8080/ws/reader/persistent/my-tenant/my-ns/my-topic1",
+ topic =
"ws://localhost:8080/ws/v2/reader/persistent/my-tenant/my-ns/my-topic1",
ws = new WebSocket(topic);
ws.on('message', function(message) {
diff --git a/site/docs/latest/cookbooks/RetentionExpiry.md
b/site/docs/latest/cookbooks/RetentionExpiry.md
index 8191e56684..60beed2d60 100644
--- a/site/docs/latest/cookbooks/RetentionExpiry.md
+++ b/site/docs/latest/cookbooks/RetentionExpiry.md
@@ -97,9 +97,9 @@ $ pulsar-admin namespaces set-retention
my-prop/my-cluster/my-ns \
#### REST API
-{% endpoint POST /admin/namespaces/:property/:cluster/:namespace/retention %}
+{% endpoint POST /admin/v2/namespaces/:tenant/:namespace/retention %}
-[More
info](../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace/retention)
+[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/retention)
#### Java
@@ -130,9 +130,9 @@ $ pulsar-admin namespaces get-retention
my-prop/my-cluster/my-ns
#### REST API
-{% endpoint GET /admin/namespaces/:property/:cluster/:namespace/retention %}
+{% endpoint GET /admin/v2/namespaces/:tenant/:namespace/retention %}
-[More
info](../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace/retention)
+[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/retention)
#### Java
@@ -181,9 +181,9 @@ $ pulsar-admin namespaces set-backlog-quota
my-prop/my-cluster/my-ns \
#### REST API
-{% endpoint POST /admin/namespaces/:property/:cluster/:namespace/backlogQuota
%}
+{% endpoint POST /admin/v2/namespaces/:tenant/:namespace/backlogQuota %}
-[More
info](../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace/backlogQuota)
+[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/backlogQuota)
#### Java
@@ -215,9 +215,9 @@ $ pulsar-admin namespaces get-backlog-quotas
my-prop/my-cluster/my-ns
#### REST API
-{% endpoint GET
/admin/namespaces/:property/:cluster/:namespace/backlogQuotaMap %}
+{% endpoint GET /admin/v2/namespaces/:tenant/:namespace/backlogQuotaMap %}
-[More
info](../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace/backlogQuota)
+[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/backlogQuota)
#### Java
@@ -238,9 +238,9 @@ $ pulsar-admin namespaces remove-backlog-quotas
my-prop/my-cluster/my-ns
#### REST API
-{% endpoint DELETE
/admin/namespaces/:property/:cluster/:namespace/backlogQuota %}
+{% endpoint DELETE /admin/v2/namespaces/:tenant/:namespace/backlogQuota %}
-[More
info](../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace/backlogQuota)
+[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/backlogQuota)
#### Java
@@ -281,9 +281,9 @@ $ pulsar-admin namespaces set-message-ttl
my-prop/my-cluster/my-ns \
#### REST API
-{% endpoint POST /admin/namespaces/:property/:cluster/:namespace/messageTTL %}
+{% endpoint POST /admin/v2/namespaces/:tenant/:namespace/messageTTL %}
-[More
info](../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace/messageTTL)
+[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/messageTTL)
#### Java
@@ -306,9 +306,9 @@ $ pulsar-admin namespaces get-message-ttl
my-prop/my-cluster/my-ns
#### REST API
-{% endpoint GET /admin/namespaces/:property/:cluster/:namespace/messageTTL %}
+{% endpoint GET /admin/v2/namespaces/:tenant/:namespace/messageTTL %}
-[More
info](../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace/messageTTL)
+[More
info](../../reference/RestApi#/admin/namespaces/:tenant/:namespace/messageTTL)
#### Java
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
