[fix][broker] update rest endpoint method names to avoid swagger conflict #20359
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tisonkun
reviewed
May 19, 2023
src/gen-swagger.sh
Outdated
There was a problem hiding this comment.
We can actually remove this file since the site repo is moved out to https://github.com/apache/pulsar-site.
And we write a similar script for generating swagger files: https://github.com/apache/pulsar-site/blob/main/tools/pytools/lib/execute/swagger_generator.py
There was a problem hiding this comment.
@tisonkun Thanks, I have removed the gen-swagger.sh script.
Renames two rest endpoint methods which were incorrectly named and cause an ID conflict in the generated swagger. This change also removes the gen-swagger.sh script which is no longer used. Signed-off-by: Paul Gier <paul.gier@datastax.com>
pgier
force-pushed
the
fix-swagger-operation-ids
branch
from
5dbf726 to
de866b7
Compare
nodece
approved these changes
May 20, 2023
nodece
approved these changes
May 20, 2023
|
/pulsarbot rerun-failure-checks |
Codecov Report
@@ Coverage Diff @@
## master #20359 +/- ##
=============================================
+ Coverage 36.97% 72.90% +35.93%
- Complexity 12043 31759 +19716
=============================================
Files 1687 1864 +177
Lines 128760 138318 +9558
Branches 14003 15173 +1170
=============================================
+ Hits 47612 100845 +53233
+ Misses 74851 29465 -45386
- Partials 6297 8008 +1711
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Renames two rest endpoint methods which were incorrectly named and cause an ID conflict in the generated swagger.
This change also skips the license check when generating the swagger spec file.
Motivation
Swagger generation uses the method/function name for the ID of the endpoint. This causes problems downstream when trying to generate admin client sources based on the swagger.
Modifications
Changed two method names related to namespace endpoints that didn't match the endpoint. This does not affect the rest endpoints, just the method names backing them.
Verifying this change
This change is already covered by existing tests.
Does this pull request potentially affect one of the following parts:
If the box was checked, please highlight the changes
Documentation
docdoc-requireddoc-not-neededdoc-completeMatching PR in forked repository
PR in forked repository: pgier#10