fix(issues): structured issue annotations #74648
Merged
Conversation
This file contains 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
github-actions
bot
added
the
Scope: Backend
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #74648 +/- ##
==========================================
+ Coverage 73.62% 78.16% +4.53%
==========================================
Files 6722 6723 +1
Lines 299893 299908 +15
Branches 51597 51587 -10
==========================================
+ Hits 220797 234411 +13614
+ Misses 72356 59178 -13178
+ Partials 6740 6319 -421
|
malwilley
reviewed
Jul 22, 2024
| @@ -145,7 +145,7 @@ class BaseGroupSerializerResponse(BaseGroupResponseOptional): | |||
| isSubscribed: bool | |||
| subscriptionDetails: GroupSubscriptionResponseOptional | None | |||
| hasSeen: bool | |||
| annotations: Sequence[str] | |||
| annotations: dict[str, str] | |||
There was a problem hiding this comment.
We should create another TypedDict (similar to GroupProjectResponse and others at the top of the file) and type this as Sequence[Annotation]
malwilley
reviewed
Jul 22, 2024
| @@ -348,7 +348,7 @@ def map_external_issues_to_annotations(self, external_issues): | |||
| for ei in external_issues: | |||
| link = self.get_issue_url(ei.key) | |||
| label = self.get_issue_display_name(ei) or ei.key | |||
| annotations.append(f'<a href="{link}">{label}</a>') | |||
| annotations.append({"url": link, "display_name": label}) | |||
There was a problem hiding this comment.
Already mentioned, but since we changed this to displayName in the frontend we need to change it here as well
armenzg
approved these changes
Jul 22, 2024
| @@ -348,7 +348,7 @@ def map_external_issues_to_annotations(self, external_issues): | |||
| for ei in external_issues: | |||
| link = self.get_issue_url(ei.key) | |||
| label = self.get_issue_display_name(ei) or ei.key | |||
| annotations.append(f'<a href="{link}">{label}</a>') | |||
| annotations.append({"url": link, "displayName": label}) | |||
There was a problem hiding this comment.
I see no more usage of a href in the APIs 👍🏻
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.