Skip to content

Bump API schema to 678631a8#18411

Closed
sentry-api-schema-updater[bot] wants to merge 1 commit into
masterfrom
bot/bump-api-schema-to-678631a8
Closed

Bump API schema to 678631a8#18411
sentry-api-schema-updater[bot] wants to merge 1 commit into
masterfrom
bot/bump-api-schema-to-678631a8

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Jun 15, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Jun 15, 2026 3:56pm
sentry-docs Ready Ready Preview, Comment Jun 15, 2026 3:56pm

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 = '626702adb84c4fcf80899cd3ef0512f610279227';
const SENTRY_API_SCHEMA_SHA = '678631a8bf4271a3a28fa15e59f4c4c4429a4978';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Bug: The code in apiCategoriesUncached directly accesses properties of a fetched OpenAPI schema without null checks, which could cause a build failure if the schema structure changes.
Severity: MEDIUM

Suggested Fix

Add validation and defensive checks when processing the fetched OpenAPI schema. Wrap property access in try-catch blocks or use optional chaining (?.) and nullish coalescing operators (??) to provide default empty values (e.g., (data.tags || []).forEach(...)) to prevent crashes if a required field is missing.

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 function `apiCategoriesUncached` in `resolveOpenAPI.ts` fetches and
parses an OpenAPI schema. It directly accesses properties on the resulting data object,
such as `data.tags`, without defensive checks. If the schema fetched from the new commit
SHA is missing properties that the code assumes are present (like the `tags` array), the
build process will crash with a `TypeError` when `forEach` is called on `undefined`.
This lack of error handling or validation for the external schema makes the build
process brittle and susceptible to failures from upstream schema changes.

Did we get this right? 👍 / 👎 to inform future reviews.

@aldy505

aldy505 commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Conflict with newer branch, skipping this

@aldy505 aldy505 closed this Jun 17, 2026
@aldy505 aldy505 deleted the bot/bump-api-schema-to-678631a8 branch June 17, 2026 00:23
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.

1 participant