pulsar
pulsar copied to clipboard
[fix][broker] Fix incorrect API documentation for non-persistent topic
Main Issue: #24412
Motivation
The API documentation for non-persistent topic endpoints incorrectly describes them as persistent topic endpoints, which could mislead users.
Modifications
- Fix the API operation description for non-persistent topic endpoint from "Produce message to a persistent topic" to "Produce message to a non-persistent topic"
- Fix the API operation description for non-persistent topic partition endpoint from "Produce message to a partition of a persistent topic" to "Produce message to a partition of a non-persistent topic"
Verifying this change
- [x] Make sure that the change passes the CI checks. This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
If the box was checked, please highlight the changes
- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] The metrics
- [ ] Anything that affects deployment
Documentation
- [ ]
doc - [ ]
doc-required - [x]
doc-not-needed - [ ]
doc-complete
Matching PR in forked repository
PR in forked repository:
@Joforde Please add the following content to your PR description and select a checkbox:
- [ ] `doc` <!-- Your PR contains doc changes -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
/pulsarbot run-failure-checks
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 74.26%. Comparing base (
bbc6224) to head (115deaf). Report is 1154 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #24413 +/- ##
============================================
+ Coverage 73.57% 74.26% +0.69%
- Complexity 32624 32703 +79
============================================
Files 1877 1868 -9
Lines 139502 145368 +5866
Branches 15299 16630 +1331
============================================
+ Hits 102638 107962 +5324
+ Misses 28908 28863 -45
- Partials 7956 8543 +587
| Flag | Coverage Δ | |
|---|---|---|
| inttests | 27.00% <ø> (+2.41%) |
:arrow_up: |
| systests | 23.30% <ø> (-1.03%) |
:arrow_down: |
| unittests | 73.75% <ø> (+0.91%) |
:arrow_up: |
Flags with carried forward coverage won't be shown. Click here to find out more.
| Files with missing lines | Coverage Δ | |
|---|---|---|
| ...ain/java/org/apache/pulsar/broker/rest/Topics.java | 100.00% <ø> (ø) |
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.