Skip to content

Bump API schema to 5d0f31cc#16965

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

Bump API schema to 5d0f31cc#16965
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-5d0f31cc

Conversation

@getsantry
Copy link
Contributor

@getsantry getsantry bot commented Mar 16, 2026

No description provided.

@vercel
Copy link

vercel bot commented Mar 16, 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 16, 2026 6:42pm
sentry-docs Ready Ready Preview, Comment Mar 16, 2026 6:42pm

Request Review

// SENTRY_API_SCHEMA_SHA is used in the sentry-docs GHA workflow in getsentry/sentry-api-schema.
// 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 = '5d0f31cc6b28159aff0eadf93422258fa2a20c9f';
Copy link

Choose a reason for hiding this comment

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

Bug: The code does not handle HTTP errors when fetching the OpenAPI schema. A 404 response will cause an unhandled exception, crashing the build.
Severity: HIGH

Suggested Fix

In resolveOpenAPI.ts, check if the response.ok property is true after the fetch call. If it is false, throw a descriptive error to indicate that the schema file could not be fetched, preventing the call to response.json() with an invalid body.

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

Potential issue: The `resolveOpenAPI` function fetches an OpenAPI schema from a URL
constructed with the `SENTRY_API_SCHEMA_SHA` constant. The code does not validate the
HTTP response before attempting to parse it as JSON with `response.json()`. If the new
SHA points to a commit where the `openapi-derefed.json` file is missing, the fetch will
receive a 404 response with an HTML body. Attempting to parse this HTML as JSON will
throw an unhandled `SyntaxError`, which will crash the static site build process.

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