ref(api): type nullable fields in the base group serializer#116068
Merged
cvxluo merged 1 commit intoMay 23, 2026
Conversation
…Response Both fields are returned as None at runtime for unshared and unassigned issues, but the TypedDict declared them as non-nullable. Aligns the type with reality. Surfaced by an apidocs schema validation failure on the group details endpoint. Also propagates the nullability to StreamGroupSerializerSnubaResponse, which spreads the base response shape into itself. Co-authored-by: Claude <noreply@anthropic.com>
cvxluo
force-pushed
the
cvxluo/make-shareid-and-assignedto-nullable-in-basegroups
branch
from
8ff49d2 to
b3b5759
Compare
cvxluo
commented
May 21, 2026
| id: str | ||
| # from base response | ||
| shareId: NotRequired[str] | ||
| shareId: NotRequired[str | None] |
Contributor
Author
There was a problem hiding this comment.
this type is a little confusing — it is because shareId could be None, if the requester asked for shareId but it didn't exist, or the shareId key could be absent from the response entirely, if the requester asked to collapse shareId. i figure it would be best to be consistent with what the actual return type is, even though this type becomes more confusing
shashjar
approved these changes
May 21, 2026
cvxluo
deleted the
cvxluo/make-shareid-and-assignedto-nullable-in-basegroups
branch
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
2 participants
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.
For unshared / unassigned issues, the actual response from the API for endpoints using the BaseGroupSerializerResponse was null. Type that correctly in the serializer