Skip to content

docs: Update attachment header requirements in documentation #17040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tobias-wilfert merged 2 commits into from
Mar 19, 2026
Merged

docs: Update attachment header requirements in documentation #17040

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3365ae8
Update attachment header requirements in documentation
tobias-wilfert Mar 19, 2026
f1bd237
Update develop-docs/sdk/telemetry/attachments.mdx
tobias-wilfert Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion develop-docs/sdk/telemetry/attachments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ SDKs **SHOULD** send placeholders in the same envelope as the event the file is
| `attachment_length` | Integer | **REQUIRED** | Size of the referenced attachment in bytes. |
| `filename` | String | **REQUIRED** | The name of the uploaded file without a path component. |

The item header **MAY** also contain `attachment_type` and the original file's `content_type` as an additional field (see [Standard Attachment Item](#standard-attachment-item)).
The item header **MUST** also contain the original file's `attachment_type` if it was set. The item payload **MUST** contain the original file's `content_type` as a field in the JSON object (see [Standard Attachment Item](#standard-attachment-item)).
Copy link

@sentry sentry bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The documentation introduces contradictions. Prose requires attachment_type in the header and content_type in the payload, but the corresponding tables and examples mark them as missing or optional.
Severity: MEDIUM

Suggested Fix

Update the documentation to be consistent. Either modify the prose to align with the tables and examples, or update the tables and examples to reflect the MUST requirements for attachment_type in the item header and content_type in the item payload. For example, add attachment_type to the item headers table and change content_type in the payload table from OPTIONAL to REQUIRED.

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#L258

Potential issue: The documentation change introduces two contradictions that will likely
cause interoperability issues between different SDK and Relay implementations. First,
the prose at line 258 states the item header `MUST` contain `attachment_type` if set,
but the corresponding item header table and the provided example omit this field.
Second, the prose states the item payload `MUST` contain `content_type`, but the payload
field table marks this field as `OPTIONAL`. These inconsistencies will lead to divergent
implementations, potentially causing problems with how attachments are processed.

Did we get this right? 👍 / 👎 to inform future reviews.

Copy link
Member

@jjbayer jjbayer Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this will make sentry bot happy:

Suggested change
The item header **MUST** also contain the original file's `attachment_type` if it was set. The item payload **MUST** contain the original file's `content_type` as a field in the JSON object (see [Standard Attachment Item](#standard-attachment-item)).
The item header **MUST** also contain the original file's `attachment_type` if it was set. The item payload **MUST** contain the original file's `content_type` as a field in the JSON object if it was set (see [Standard Attachment Item](#standard-attachment-item)).


**Item payload:**

Expand Down
Loading