Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| |-------|------|----------|-------------| | ||
| | `type` | String | **REQUIRED** | **MUST** be `"attachment"`. | | ||
| | `content_type` | String | **REQUIRED** | **MUST** be `"application/vnd.sentry.attachment-ref+json"`. | | ||
| | `attachment_type` | String | **REQUIRED** | **MUST** be `event.attachment` (no special processing). | |
There was a problem hiding this comment.
Bug: The documentation for attachment placeholders is contradictory. The attachment_type field is marked as REQUIRED in one place but is described as conditional and omitted from an example elsewhere.
Severity: MEDIUM
Suggested Fix
Update the documentation to be consistent. The prose on line 259 should be changed to state that attachment_type is always required. The JSON example on line 391 should be updated to include the "attachment_type":"event.attachment" field to match the specification.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: develop-docs/sdk/telemetry/attachments.mdx#L254
Potential issue: The documentation for attachment placeholders in
`develop-docs/sdk/telemetry/attachments.mdx` contains conflicting information regarding
the `attachment_type` field. A newly added table on line 254 specifies that
`attachment_type` is a `REQUIRED` field. However, pre-existing prose on line 259 implies
it is conditional, stating it should be included "if it was set". Furthermore, an
example envelope on line 391 omits the `attachment_type` field entirely. This
contradictory guidance will likely lead to inconsistent SDK implementations, with some
treating the field as required, some as conditional, and others as optional, undermining
protocol compliance.
Did we get this right? 👍 / 👎 to inform future reviews.
loewenheim
approved these changes
Apr 2, 2026
tobias-wilfert
approved these changes
Apr 2, 2026
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
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.
DESCRIBE YOUR PR
The upload endpoint can only be used for plain attachments, so we should restrict the
attachment_typeitem header.ref: https://linear.app/getsentry/project/super-sized-attachments-d6ccf1b64c8d
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: