fix(api-docs): correct event/replay/processing-error ID schemas#116201
Merged
cvxluo merged 1 commit intoMay 26, 2026
Conversation
github-actions
Bot
added
the
Scope: Backend
JoshFerge
approved these changes
May 26, 2026
shashjar
approved these changes
May 26, 2026
| type=OpenApiTypes.UUID, | ||
| description="The ID of the processing error.", | ||
| type=OpenApiTypes.STR, | ||
| pattern="^[0-9a-f]{32}$", |
Member
There was a problem hiding this comment.
non-blocking nit but might be worth defining hex pattern as a constant?
cvxluo
force-pushed
the
cvxluo/correct-eventreplayprocessing-error-id-schemas
branch
from
f90af6e to
28234be
Compare
Sentry's event_id, replay_id, and processing_error_id are 32-char hex strings without dashes, not standard RFC 4122 UUIDs. Replace OpenApiTypes.UUID with OpenApiTypes.STR plus a pattern constraint so the published OpenAPI spec accurately describes the IDs the API actually accepts and returns. Co-authored-by: Claude <noreply@anthropic.com>
cvxluo
force-pushed
the
cvxluo/correct-eventreplayprocessing-error-id-schemas
branch
from
28234be to
348bc9e
Compare
3 tasks
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
3 participants
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.
While working on #116059, I noticed that some of our API parameters are marked as UUID, when they actually accept hex id values, so are technically non-comforming. Adjust the OpenAPI spec to indicate this, and add a hint that these parameters are hex ids.
I considered using a more holistic solution by making a new
OpenAPIParameter, but decided against it for now, since these cases are rather limited. If we find that we keep needing to use this form of hex parameter, we can reconsider