Anonymitaet commented on a change in pull request #5791: [Issue 5638][docs] Add
explanation about the v1 REST API
URL: https://github.com/apache/pulsar/pull/5791#discussion_r353658684
##########
File path: site2/docs/admin-api-overview.md
##########
@@ -30,6 +30,14 @@ In this document, examples from each of the three available
interfaces will be s
Each of Pulsar's three admin interfaces---the
[`pulsar-admin`](reference-pulsar-admin.md) CLI tool, the [Java admin
API](/api/admin), and the {@inject: rest:REST:/} API ---requires some special
setup if you have
[authentication](security-overview.md#authentication-providers) enabled in your
Pulsar [instance](reference-terminology.md#instance).
+> If you are using an old version of a namespace, you need to use `v1` to
replace `v2` in the request URL
+if you are requesting the HTTP service directly. If you are using the
pulsar-admin to request the v1
+service, you will encounter an exception with HTTP code 405 that shows you are
requesting a not supported
+method in the v1 version. About the supported method in the v1, please refer
to the
+[v1 Admin
API](https://github.com/apache/pulsar/tree/master/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v1).
+About the old version of a namespace, please refer to the
+[namespace name
changes](https://github.com/apache/pulsar/wiki/PIP-10:-Remove-cluster-for-namespace-and-topic-names).
+
Review comment:
I've made some changes based on our discussed before:
1. Add the following note for `REST API` section
```
Note: if you are using an old version of a namespace and requesting the HTTP
service directly, you need to use `v1` to replace `v2` in the request URL.
For more information about the old version of a namespace, see [namespace
name
changes](https://github.com/apache/pulsar/wiki/PIP-10:-Remove-cluster-for-namespace-and-topic-names).
```
2. Add the following tip for `pulsar-admin` section
```
Tip: if you are using the pulsar-admin to request `v1`
service, you will encounter an exception with HTTP code 405 showing that the
method you are requesting is not supported in `v1`.
For more information about the **supported method in `v1`**, see
[v1 Admin
API](https://github.com/apache/pulsar/tree/master/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v1).
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
