Skip to content

Bump API schema to 6465c0af#16972

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

Bump API schema to 6465c0af#16972
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-6465c0af

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 10:19pm
sentry-docs Ready Ready Preview, Comment Mar 16, 2026 10:19pm

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 = '6465c0aff4f3485a73f7e97f4c39474229f47418';
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 fetching and processing logic in resolveOpenAPI.ts lacks error handling and validation, making the build process brittle and prone to crashing.
Severity: HIGH

Suggested Fix

Add a check for response.ok after the fetch call to handle non-successful HTTP statuses. Wrap the data processing logic in apiCategoriesUncached with defensive checks to ensure properties like data.tags, data.paths, and categoryMap[tag] exist before they are accessed. This will prevent crashes from both network failures and unexpected schema structures.

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 and parses an OpenAPI schema
without proper error handling or data validation. If the fetch operation fails (e.g.,
due to an invalid SHA returning a 404 error), the code attempts to parse a non-JSON
response, causing a `SyntaxError` that crashes the build process. Additionally, even
with a valid JSON response, the `apiCategoriesUncached` function assumes a specific
schema structure. It can crash with a runtime error if an API endpoint in `data.paths`
references a `tag` not defined in `data.tags`, or if properties like `data.tags` or
`apiData.tags` are missing.

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