[AVC] Fix missing elementId and add test #13443
Merged
+23
−5
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
tjprescott
added
the
bug
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes an issue where Pydantic model instantiation would fail when certain fields (particularly ElementId) are missing from Cosmos DB query results. The fix adds explicit default=None to all Optional fields in the APIViewComment model, making them truly optional rather than required-but-nullable.
Key Changes:
- Added
default=Noneto eight Optional fields inAPIViewCommentmodel that previously lacked explicit defaults - Added test case
test_metrics_report_missing_element_idto verify the fix handles missing fields gracefully
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/python-packages/apiview-copilot/src/_models.py | Added default=None to Optional fields (id, review_id, api_revision_id, element_id, comment_text, created_by, created_on, comment_type) in the APIViewComment class to make them truly optional when deserializing from Cosmos DB |
| packages/python-packages/apiview-copilot/tests/metrics_test.py | Added test case to verify metrics report generation doesn't fail when ElementId field is missing from comment dictionaries |
Member
Author
|
/check-enforcer evaluate |
AlitzelMendez
approved these changes
Jan 8, 2026
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.
Fixes issue where elementId might be missing from comments.