Clarify accepted image-data formats (emoji also accepts WebP/AVIF) - #8538
Draft
spenhand wants to merge 1 commit into
Draft
Clarify accepted image-data formats (emoji also accepts WebP/AVIF)#8538spenhand wants to merge 1 commit into
spenhand wants to merge 1 commit into
Conversation
The Image Data section stated the Data URI "supports JPG, GIF, and PNG formats" without qualification, which contradicts the Emoji Formats section (emoji accept JPEG, PNG, GIF, WebP, and AVIF) and the actual API behavior, where the accepted format is determined per-resource from the encoded image bytes rather than from the declared content type. Note that some resources accept additional formats and point readers to the specific resource. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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
The Image Data section in
reference.mdxstates the Data URI "supports JPG, GIF, and PNG formats" with no qualification. That contradicts the Emoji Formats section (emoji.mdx), which correctly lists JPEG, PNG, GIF, WebP, and AVIF for emoji — and it contradicts actual API behavior, where the accepted format is determined per-resource by sniffing the encoded image bytes, not from the declared data-URI content type.This tripped up an integration: a developer reading the emoji endpoint's
imagefield followed the link to Image Data, saw "JPG, GIF, PNG only," and concluded animated WebP couldn't be uploaded — when in fact it can.Change
Reword the Image Data section to:
No endpoint behavior changes — docs only.