Skip to content

Bump API schema to ddda9506 #16897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
getsantry wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Bump API schema to ddda9506 #16897

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/build/resolveOpenAPI.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {DeRefedOpenAPI} from './open-api/types';

// 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 = '0583755a815d16d432791204c3547c39483345d6';
const SENTRY_API_SCHEMA_SHA = 'ddda95066e1e5469719906060605f9fec04010e5';
Copy link

@sentry sentry bot Mar 11, 2026

Choose a reason for hiding this comment

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

Bug: The code may crash in apiCategoriesUncached when an API uses a tag not defined in data.tags, leading to an attempt to access a property on undefined.
Severity: CRITICAL

Suggested Fix

Before pushing to the apis array within the apiData.tags.forEach loop, add a check to verify that categoryMap[tag] exists. If it does not, either skip the tag or log a warning to prevent the build from crashing.

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 populates a
`categoryMap` using tags from `data.tags`. It then iterates through API endpoints and
their associated tags. If an API endpoint uses a tag that is not present in the initial
`data.tags` list, the code will attempt to access the `apis` property on an `undefined`
value (`categoryMap[tag]`). This will throw a `Cannot read properties of undefined
(reading 'apis')` error, causing the documentation build process to crash.

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


const activeEnv = process.env.GATSBY_ENV || process.env.NODE_ENV || 'development';

Expand Down
Loading