Bump API schema to {"messag #16229
Bump API schema to {"messag #16229
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![cursor[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
| // 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 = '66c1827096e4cd8f8b5074c316c67975015a84ba'; | ||
| const SENTRY_API_SCHEMA_SHA = '{"message":"API rate limit exceeded for 172.182.213.147. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)","documentation_url":"https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting"}'; |
There was a problem hiding this comment.
GitHub API error response accidentally committed as SHA
High Severity
The SENTRY_API_SCHEMA_SHA constant was replaced with a GitHub API rate limit error JSON response instead of a valid Git commit SHA. This value is used to construct a URL for fetching the OpenAPI schema from GitHub raw content. The resulting URL will be completely invalid, causing the resolveOpenAPI() function to fail when fetching the API schema, which will break the documentation build.
![sentry[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| // 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 = '66c1827096e4cd8f8b5074c316c67975015a84ba'; | ||
| const SENTRY_API_SCHEMA_SHA = '{"message":"API rate limit exceeded for 172.182.213.147. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)","documentation_url":"https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting"}'; |
There was a problem hiding this comment.
Bug: The SENTRY_API_SCHEMA_SHA constant is an invalid JSON string, not a Git SHA, which will break URL generation and cause build and runtime failures.
Severity: CRITICAL
Suggested Fix
Replace the invalid JSON string in the SENTRY_API_SCHEMA_SHA constant with the correct, valid Git SHA for the sentry-api-schema repository. The previous valid SHA was 66c1827096e4cd8f8b5074c316c67975015a84ba.
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 `SENTRY_API_SCHEMA_SHA` constant at
`src/build/resolveOpenAPI.ts:11` has been assigned an invalid value—a JSON string
representing a GitHub API error—instead of a valid Git SHA. This variable is used to
construct a URL to fetch the OpenAPI schema. The resulting malformed URL causes the
`fetch` call to throw an unhandled error. This error propagates, leading to build-time
failures when generating the documentation index and runtime crashes when serving API
documentation pages, making them inaccessible.
Did we get this right? 👍 / 👎 to inform future reviews.
No description provided.