Repository navigation
Bump API schema to 7b9f8d9b - #20221
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Please update the IS YOUR CHANGE URGENT? section of the PR description:
This information helps the Docs team prioritize your review. |
|
The plan checks API page loads, API not-found counts, and client errors on API URLs. An issue escalates when API page loads fall while other pages hold. It also escalates when API not-found counts or API-page errors rise. Services: PlanWhat changedThe docs build now pins the public API schema to SHA 7b9f8d9b. That schema commit changed only rpc_method_schema.json. The build fetches openapi-derefed.json, which did not change in this pin. API reference pages should keep the same paths and fields. sentry-docs must deploy before the pin is live on API pages. develop-docs also deploys this src file. develop-docs does not render OpenAPI pages. Catalog and Vercel deploy config both ship src to these two services. These signals live in Sentry project docs. They move when sentry-docs deploys. RiskA bad pin can fail the sentry-docs build or omit API routes. Users then see not-found pages on old API URLs. A malformed schema can throw while an API page renders. develop-docs does not fetch the schema at build. A SHA-only edit should not change develop-docs pages. Intended effectThis pin does not add a new API page or field. The intended effect is that API pages still load after the rebuild. Absent: API page loads drop while platforms page loads hold.
Regression watchA slug change would 404 old API URLs. A render fault would raise client errors on those URLs. Platforms page loads show whether traffic dropped site-wide.
Not observableLive pages do not expose the schema SHA. rpc_method_schema.json is not read by this site. A traces query for API 4xx and 5xx timed out. The not-found metric listing returns only the top requested_path groups. Smaller api paths may be missing from that list. develop-docs has no OpenAPI page-load signal. |
|
Verified in
|
No description provided.