Skip to content

Bump API schema to 259e6bfc#17042

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

Bump API schema to 259e6bfc#17042
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-259e6bfc

Conversation

@getsantry
Copy link
Contributor

@getsantry getsantry bot commented Mar 19, 2026

No description provided.

@vercel
Copy link

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

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 = '259e6bfcd1b0e68776314ec2b0f96567d49a941d';
Copy link

Choose a reason for hiding this comment

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

Bug: The fetch call to retrieve the OpenAPI schema lacks response validation, which can cause an unhandled rejection and crash the build if the request fails.
Severity: HIGH

Suggested Fix

After the fetch call in resolveOpenAPI.ts, add a check for response.ok. If the response is not successful, throw a descriptive error to prevent the response.json() call from executing on an invalid body and to ensure build failures are clear and debuggable.

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 `fetch` call in `resolveOpenAPI` to retrieve the OpenAPI schema
from `raw.githubusercontent.com` does not validate the HTTP response status. If the
request returns a non-2xx status code (e.g., 404 Not Found), the code will still attempt
to parse the response body using `response.json()`. This will likely throw an error if
the body is not valid JSON, such as an HTML error page. Because the callers of the
parent function `apiCategories()` do not have `try/catch` blocks, this unhandled promise
rejection will crash the build process or the server component at runtime.

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