apache / apache/pulsar

[Doc] REST API doc for Managing Tenants is incorrect

Open
#22,094 0 comments 0 reactions 0 assignees View on GitHub
doc-required
Dominant language
Java
Stars
15.3k
Forks
3.8k
Avg merge
1d 14h
Merged PRs (30d)
160

Description

### Search before asking

- [X] I searched in the [issues](https://github.com/apache/pulsar/issues) and found nothing similar.

### What issue do you find in Pulsar docs?

The URL for manging tenants is wrong:
image

### What is your suggestion?

It should be like:
`PUT /admin/v2/tenants/:tenant`. (without the `createTenants` part)

### Any reference?

- Original issue: https://github.com/apache/pulsar-client-go/issues/1179 Thanks @ThinhLe30 for reporting this issue.

- API doc reference: https://pulsar.apache.org/admin-rest-api/?version=3.1.2&apiversion=v2#operation/TenantsBase_updateTenant

- Code reference: https://github.com/apache/pulsar/blob/bbdc173e80157296ff0475cfdc4e36f5d063a7df/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/TenantsBase.java#L111

### Are you willing to submit a PR?

- [ ] I'm willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Start by checking TenantsBase.java at the referenced line and comparing it with the Admin REST API documentation for TenantsBase_updateTenant. Update the Managing Tenants documentation so the endpoint is shown as PUT /admin/v2/tenants/:tenant, then verify the rendered documentation no longer includes createTenants.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.