Remove claim for Discord avatar #585
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
kevinchalet
approved these changes
Aug 25, 2021
Rather than maintain logic to understand how Discord builds up avatar URLs and handles different image format, remove the computed "avatar URL" claim. Consumers can instead author their own MapCustomJson on the ClaimActions and derive the location based on their own requirements.
Add some sample code to the documentation showing how to map the user's avatar URL to a claim.
975f5ae to
9470bbe
Compare
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.
Rather than maintain logic to understand how Discord builds up avatar URLs and handles different image formats, this PR removes the computed "avatar URL" claim for the v6 release while we have the opportunity to make breaking changes.
Consumers can instead author their own
MapCustomJson(...)on theClaimActionsand derive the URI based on their own requirements.As this is pretty easy to do using the extensibility that already exists, I think this is a long-term more preferable and maintainable solution than us trying to keep in step with whatever it is that Discord is doing for their avatar image storage.
If we decide this is the route we want to go down, I'll add an example implementation that mirrors what previous versions did with a tweak to support the animated case into the Markdown document. Users can then copy-paste that into their app configuration if they need it.
We could also optionally add
[Obsolete]to these properties in the dev branch for v5 to give some advance notice to it being removed in v6.Relates to #584.