docs(integration-platform): Document error-surfacing convention for all UI components#18505
Merged
priscilawebdev merged 8 commits intoJun 24, 2026
Conversation
…ll UI components Sentry now forwards the integrator's HTTP status code and surfaces the `message` from the error response body for issue link, select option, and alert rule action external requests. Previously only the alert rule action documented this convention. Extract the convention into a shared include and reference it from the issue link, select FormField, and alert rule action component docs so integrators get consistent guidance on returning actionable errors. Refs DE-1275 Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
…hared include Each page repeated a component-specific intro and trailing sentence around the include. Make the intro and consequence generic and fold them into the include so the convention lives in one place; pages now only carry the heading and the include reference. Co-Authored-By: Claude <noreply@anthropic.com>
…e shared include The heading was the last duplicated line on each page. Fold it into the include (normalized to a level-2 heading) so each page references the section with a single include and the entire block lives in one place. Co-Authored-By: Claude <noreply@anthropic.com>
… in include Revert the rewritten copy back to the original phrasing, genericized so the shared block fits the issue link, select FormField, and alert rule action components. Co-Authored-By: Claude <noreply@anthropic.com>
…message behavior Sentry now forwards the integrator's HTTP status code and surfaces the `message` from the error response body, falling back to a generic message when none is provided and a 502 when the service doesn't respond. Update the shared block to match. Co-Authored-By: Claude <noreply@anthropic.com>
…equest types The inherited "submits an incorrect or malformed configuration" wording only fit the form-submission components and not the Select options request, which is a GET that loads options. Reword the shared opener to cover any failed request. Co-Authored-By: Claude <noreply@anthropic.com>
… surfacing-errors Sentry makes the request to your service, so "a request from this component" was slightly inaccurate. The surrounding page already establishes which component. Co-Authored-By: Claude <noreply@anthropic.com>
…pener Replace the product-jargon "surface the reason" with "show the user a specific error message" for clarity. Co-Authored-By: Claude <noreply@anthropic.com>
markstory
approved these changes
Jun 23, 2026
priscilawebdev
deleted the
priscilawebdev/docs/surface-integrator-errors-ui-components
branch
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
2 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.
Document the error-surfacing response convention across all Sentry App UI components that make external requests (issue link, alert rule action, and Select FormField options), via a shared include. Follow-up to docs feedback on getsentry/sentry#116956 (comment).