errata_utils.py: use /packages?name=<name> rather than /packages/<name> #374
Conversation
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
The errata API route /packages/<name> doesn't work when <name> includes a `.` (it returns an internal server error). However, we can use /packages?name=<name> to get the same data.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the Errata API call for fetching package information to use query parameters instead of embedding the package name in the URL path. This is a good change as it correctly handles package names with special characters like periods.
However, I've found a critical issue in the implementation. The new code assumes the API returns a single object, but based on conventions and other parts of the codebase, it's highly likely that a filtered API call returns a list of objects. My review includes a comment with a suggested fix to handle the list response correctly, preventing a runtime error.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The errata API route /packages/ doesn't work when includes a
.(it returns an internal server error). However, we can use /packages?name= to get the same data.(I asked the Errata Tool maintainer about this, and apparently this type of error is an artifact of Ruby-on-Rails
routing and hard to fix.)