Bump API schema to 5aa8bd7e#16996
Open
getsantry[bot] wants to merge 1 commit intomastergetsentry/sentry-docs:masterfrom
bot/bump-api-schema-to-5aa8bd7egetsentry/sentry-docs:bot/bump-api-schema-to-5aa8bd7eCopy head branch name to clipboard
Open
Bump API schema to 5aa8bd7e#16996getsantry[bot] wants to merge 1 commit intomastergetsentry/sentry-docs:masterfrom bot/bump-api-schema-to-5aa8bd7egetsentry/sentry-docs:bot/bump-api-schema-to-5aa8bd7eCopy head branch name to clipboard
getsantry[bot] wants to merge 1 commit intomastergetsentry/sentry-docs:masterfrom
bot/bump-api-schema-to-5aa8bd7egetsentry/sentry-docs:bot/bump-api-schema-to-5aa8bd7eCopy head branch name to clipboard
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| // 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 = '5aa8bd7e1e9cea540dad51e4bda4febf9e1d2e63'; |
There was a problem hiding this comment.
Bug: The code in apiCategoriesUncached() may cause a TypeError if an API endpoint's tags array contains a tag not defined in the top-level schema tags.
Severity: MEDIUM
Suggested Fix
Add a defensive check before accessing categoryMap[tag]. Ensure that the tag exists as a key in categoryMap before attempting to call .apis.push() on it. This will prevent the build from crashing if the schema contains an inconsistent tag reference.
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 `apiCategoriesUncached` function populates a `categoryMap` based on
the top-level `data.tags` from the OpenAPI schema. It then iterates through each API
endpoint's `tags` and attempts to push data into `categoryMap[tag].apis`. If an
endpoint's `tags` array contains a tag that was not present in the initial top-level
`data.tags` list, `categoryMap[tag]` will be `undefined`. This will cause a `TypeError`
when the code attempts to access the `.apis` property, leading to a crash during the
static site generation build process.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.