Skip to content

Bump API schema to 43a08415#16989

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

Bump API schema to 43a08415#16989
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-43a08415

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 3:14pm
sentry-docs Ready Ready Preview, Comment Mar 17, 2026 3:14pm

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 = '43a08415e12ae4aa680595d1bef5cd69527156c9';

Copy link

Choose a reason for hiding this comment

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

Bug: The OpenAPI schema fetch logic lacks error handling for HTTP failures and does not validate the response structure, which can crash the build process.
Severity: MEDIUM

Suggested Fix

Implement robust error handling around the fetch call. Check if response.ok is true before calling response.json() to handle non-2xx HTTP statuses. Additionally, wrap the fetch and parsing logic in a try...catch block. Before using the parsed data, validate that required properties like tags and paths exist to prevent runtime errors.

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 schema from a remote URL
but does not handle potential failures. It lacks checks for HTTP errors (like 404 Not
Found) before attempting to parse the response body. Furthermore, downstream code in
`apiCategoriesUncached` directly accesses properties like `data.tags` and `data.paths`
without validating their existence. If the remote file is missing, the network request
fails, or the JSON structure is unexpected, the application will throw a runtime error
during the build process, causing the entire build to fail.

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