Repository navigation
Handle a blank endpoint or parameter description without crashing - #121
Open
arpitjain099 wants to merge 1 commit into
Open
arpitjain099 wants to merge 1 commit into
arpitjain099 wants to merge 1 commit into
Conversation
Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Arpit Jain <arpitjain099@gmail.com>
This file contains hidden or 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
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.
FerryParser.parse_descriptionwraps the description and then takesdescription_lines[0]unconditionally.textwrap.wrapreturns an empty list for an empty or whitespace-only string, so a blank description raisesIndexErrorinstead of producing a help line.It is reachable from normal startup.
generate_endpointspassesdata[method]["description"]straight intocreate_subparser, andset_argumentspasses eachparam["description"]in too, so a single endpoint or parameter with an empty description aborts endpoint generation for the whole CLI.I drove
generate_endpointsagainst small local swagger files. A well-formed one builds its endpoint; an endpoint with"description": ""and a parameter with"description": " "both raisedIndexError: list index out of rangebefore this change and build fine after. The new tests fail on master and pass with the fix, and the rest of the suite is unchanged (the 4test_api.pyerrors are a missing localhtgettoken, either way).FerryCLI.parse_descriptionhas the same unguarded indexing but no callers, so I left it out rather than widen this PR. Happy to include it if you would rather they matched.