fix(formatting): unblock CI for llmFormat response types#120105
Closed
shayna-ch wants to merge 1 commit into
Closed
fix(formatting): unblock CI for llmFormat response types#120105shayna-ch wants to merge 1 commit into
shayna-ch wants to merge 1 commit into
Conversation
NotRequired is ignored under from __future__ import annotations, so OpenAPI treated `formatted` as required and example validation failed. Use total=False TypedDict mixins instead, and cast the event details response so mypy accepts the annotated return type. Co-authored-by: Shayna Chambless <shayna-ch@users.noreply.github.com>
github-actions
Bot
added
the
Scope: Backend
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.
Summary
Fixes the CI failures on #119545 (
backend typing+api docs test).Root causes
NotRequired[...]on TypedDict fields is ignored when the module hasfrom __future__ import annotations, so OpenAPI markedformattedas required and example validation failed.wrap_event_responsereturnsGroupEventDetailsResponse, which didn't match the annotatedResponse[GroupEventDetailsFormattedResponse].Fix
total=FalseTypedDict mixins for the optionalformattedfield (same pattern used elsewhere in serializers).GroupEventDetailsFormattedResponseon return.Test plan
prekmypy on changed filesformattedis in__optional_keys__for both response TypedDictsbackend typingandapi docs testpass on this PR