Skip to content

Bump API schema to 149c5eb7#16849

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

Bump API schema to 149c5eb7#16849
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-149c5eb7

Conversation

@getsantry
Copy link
Contributor

@getsantry getsantry bot commented Mar 9, 2026

No description provided.

@vercel
Copy link

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

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 = 'b02b0fc72d6cd844ace73aa326582f921bd50bce';
const SENTRY_API_SCHEMA_SHA = '149c5eb7c15d8d6637011a32cccfcedc5893fd89';

Copy link

Choose a reason for hiding this comment

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

Bug: The code accesses categoryMap[tag] without verifying the tag exists. An API tag not defined in the root data.tags will cause a build-time crash.
Severity: HIGH

Suggested Fix

Add a defensive check to ensure categoryMap[tag] is defined before attempting to access its apis property. For example: if (categoryMap[tag]) { categoryMap[tag].apis.push({ ... }); }. This prevents the build from crashing if an API uses a tag not declared at the root level.

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 code populates a `categoryMap` using tags from the root-level
`data.tags`. It then iterates through each API's `apiData.tags` and attempts to access
`categoryMap[tag].apis.push(...)`. If an API operation uses a tag that is not defined in
the root `data.tags`, `categoryMap[tag]` will be `undefined`, causing a "Cannot read
property 'apis' of undefined" runtime error. This will crash the documentation build
process. The OpenAPI specification does not require all operation tags to be defined at
the root level, making this a potential point of failure with schema updates.

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