Repository navigation
Bump API schema to 2adfc005 - #20087
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 that the rebuilt API reference shows the new tags field. It also watches API page loads, API not-found counts, and client errors on API URLs. An issue escalates when the tags field is missing, when API pages 404, or when those errors rise. Services: Mention PlanWhat changedPublic API reference pages now build from OpenAPI schema 2adfc005. The events-dropped docs page documents a required tags string array on outcomes objects. The change is live after sentry-docs deploys this pull request. The Vercel project and catalog path for the public docs site match that id. develop-docs rebuilds from the same repository but does not call apiCategories and does not serve OpenAPI pages. RiskA bad schema can fail the production docs build. It can also drop or break every API reference page. A smaller miss leaves the events-dropped page without tags or with a broken response schema. Client render errors can then appear on API URLs. Intended effectThe live events-dropped page must document the new tags field. Absent means that page still omits tags after the deploy, or the page returns 404.
Page loads alone do not confirm this content change. Low explore traffic can stay quiet after a good deploy. Regression watchA failed schema rebuild can 404 every API page. Watch 404s, client errors, and API page volume. The events-dropped page sits under explore, so also split that slice.
If 404s rise, inspect whether generateStaticParams still emitted API paths. If client errors rise, inspect ApiPage render failures on those URLs. Not observableThe schema diff copies the tags object four times. This plan could not prove a second public endpoint besides events-dropped. The live markdown export for that page had an empty response schema, so the HTML page is the source for tags. This session did not measure a matching 24h split for url:"/api/" errors. A transaction:/api/ trace query returned 0. Use url.full instead. develop-docs has no OpenAPI pages, so schema content is not observable there. A build-time schema fetch failure appears as a failed Vercel deploy, not as a Sentry metric. |
No description provided.