Namespace-level publish rate limits are poorly documented
- Dominant language
- Java
- Stars
- 15.3k
- Forks
- 3.8k
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 160
Description
**Describe the bug**
Two issues:
1. The documentation for how to set namespace-level publish rate limits is confusing. Its given example is:
```
"publishMaxMessageRate": {
"additionalProp1": {
"publishThrottlingRateInMsg": 0,
"publishThrottlingRateInByte": 0
},
"additionalProp2": {
"publishThrottlingRateInMsg": 0,
"publishThrottlingRateInByte": 0
},
"additionalProp3": {
"publishThrottlingRateInMsg": 0,
"publishThrottlingRateInByte": 0
}
},
```
There is no information as to:
- What `additionalProp1` etc. should be.
- What it means to supply multiple groups of msg/byte rate limits.
- Whether both Msg and Byte must be supplied for each sublimit.
**Expected behavior**
The OpenAPI documentation would contain information indicating how these should be set when namespaces are created.
Contributor guide
Research direction
Start by locating the OpenAPI documentation for namespace creation and inspect the publishMaxMessageRate example. Clarify what each additional property represents, how multiple message/byte limits work, and whether both values are required; done means the documentation answers these questions with a usable example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100