Skip to content

Bump API schema to 3ada0722#16994

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

Bump API schema to 3ada0722#16994
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-3ada0722

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

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 = '3ada072206640f535d89016c2ca1c288a3ab8664';
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 does not validate that an API endpoint's tag exists in the global categoryMap before use, which can lead to a crash if the schema contains an unknown tag.
Severity: HIGH

Suggested Fix

Before accessing categoryMap[tag], add a check to ensure the key exists. If the tag is not found in categoryMap, you could either skip it (potentially with a warning) or handle it as an error, preventing the build from crashing. For example: if (categoryMap[tag]) { categoryMap[tag].apis.push(...); }.

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: In the `apiCategoriesUncached` function, the code iterates through tags
associated with each API endpoint (`apiData.tags`) and uses them as keys to access a
`categoryMap`. This map is populated from a global `data.tags` list. However, there is
no check to verify that a tag from an endpoint exists in the `categoryMap` before
attempting to access its properties. If the new OpenAPI schema contains an endpoint with
a tag not defined in the global list, the expression `categoryMap[tag]` will be
`undefined`, causing a `TypeError` when the code tries to access `.apis.push()` on it.
This will crash the build process.

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