Skip to content

Bump API schema to ee34d268#17241

Merged
sentry-api-schema-updater[bot] merged 1 commit intomasterfrom
bot/bump-api-schema-to-ee34d268
Apr 2, 2026
Merged

Bump API schema to ee34d268#17241
sentry-api-schema-updater[bot] merged 1 commit intomasterfrom
bot/bump-api-schema-to-ee34d268

Conversation

@sentry-api-schema-updater
Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater sentry-api-schema-updater bot merged commit 1cc076b into master Apr 2, 2026
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 2, 2026

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Apr 2, 2026 6:21pm
sentry-docs Ready Ready Preview, Comment Apr 2, 2026 6:21pm

Request Review

@sentry-api-schema-updater sentry-api-schema-updater bot deleted the bot/bump-api-schema-to-ee34d268 branch April 2, 2026 18:10
// 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 = 'edac98f0b883a1416430ac0ebf0bc449bfc4091a';
const SENTRY_API_SCHEMA_SHA = 'ee34d268ce4d0b03d8f35a25b607cf78e0567a23';
Copy link
Copy Markdown

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 failed fetch requests, causing a build failure if the OpenAPI schema URL returns a non-JSON response like a 404 page.
Severity: LOW

Suggested Fix

In resolveOpenAPI, check if response.ok is true before attempting to parse the JSON. If the response is not okay, throw an informative error to handle the failure gracefully instead of letting response.json() crash on invalid input.

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

Potential issue: The `resolveOpenAPI` function fetches a schema from a raw GitHub URL
without validating the HTTP response. If the `SENTRY_API_SCHEMA_SHA` points to a
non-existent commit, GitHub will return a 404 HTML page. The code then attempts to parse
this HTML as JSON by calling `response.json()`, which will throw a `SyntaxError` and
cause the build process to fail. While CI/CD checks are expected to prevent an invalid
SHA from being merged, the lack of defensive error handling in the code itself presents
a latent vulnerability.

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