Skip to content

Bump API schema to dee58b34#16999

Open
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-dee58b34
Open

Bump API schema to dee58b34#16999
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-dee58b34

Conversation

@getsantry
Copy link
Contributor

@getsantry getsantry bot commented Mar 17, 2026

No description provided.

@vercel
Copy link

vercel bot commented Mar 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Mar 17, 2026 6:56pm
sentry-docs Ready Ready Preview, Comment Mar 17, 2026 6:56pm

Request Review

// DO NOT change variable name unless you change it in the sentry-docs GHA workflow in getsentry/sentry-api-schema.
const SENTRY_API_SCHEMA_SHA = 'd218ebe064fe5ec8cb383688e80cbf36c0a6a5e8';
const SENTRY_API_SCHEMA_SHA = 'dee58b34394d643aadf51797ba638c832444a8fd';

Copy link

Choose a reason for hiding this comment

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

Bug: The resolveOpenAPI function lacks error handling for its fetch request, which will cause an unhandled exception and crash the build if the network request fails.
Severity: MEDIUM

Suggested Fix

Check the response.ok property after the fetch call in resolveOpenAPI. If the response is not okay, throw a descriptive error or return a null value to be handled gracefully by the calling functions. This will prevent the build from crashing due to network issues or a 404 response.

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: src/build/resolveOpenAPI.ts#L12

Potential issue: The `resolveOpenAPI` function fetches a JSON file from a remote URL but
does not include any error handling or response validation. It directly calls
`response.json()` without first checking if the fetch was successful via `response.ok`
or `response.status`. If the fetch request fails for any reason, such as a transient
network error or if the requested file is unavailable (e.g., returning a 404), the call
to `response.json()` will throw an unhandled exception. Since this function is executed
during the build process, this will cause the entire build to fail abruptly.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants