Include series ID in issue list response#488
Draft
myers wants to merge 1 commit intoMetron-Project:masterfrom
Draft
Include series ID in issue list response#488myers wants to merge 1 commit intoMetron-Project:masterfrom
myers wants to merge 1 commit intoMetron-Project:masterfrom
Conversation
Add the series `id` field to IssueListSeriesSerializer so that issue search/list responses include the series ID alongside name, volume, and year_began. Without the series ID, API consumers must make a separate request to resolve the series for each search result (e.g., fetching the full issue detail just to get the series ID for caching).
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
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 IssueListSeriesSerializer currently returns name, volume, and year_began but not the series id. This means API consumers who want to cache or link series data from search results have to make a separate request per result to get the series id (either fetching the full issue or searching for the series).
Adding id to the serializer fields fixes this with no extra queries since the series is already being serialized via select_related.