Repository navigation
Bump API schema to 969b8a53 - #20177
Conversation
|
Please update the IS YOUR CHANGE URGENT? section of the PR description:
This information helps the Docs team prioritize your review. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
The plan checks API reference page loads, API-path 404s, and errors on those pages. An issue escalates when API-path 404s rise or those errors rise. Services: Mention PlanWhat changedAPI reference pages that document filter comparison operators now list cidr and not_cidr. Those pages go live after the sentry-docs production deploy. This change does not add or remove API docs routes. The develop-docs project rebuilds this repo and does not load the OpenAPI schema. RiskA failed schema fetch or parse fails the production build. A shipped bad schema can omit API pages from the static tree. Users then hit 404s on API reference paths. A render fault in the enum list can throw on those pages. This bump only adds two enum values and description text. Intended effectThe new cidr and not_cidr choices are page text. Telemetry cannot read that text. The docs.page.load counter with page_type api remaining in band shows the rebuilt API pages still load. Absent looks like that counter falling below the band while other page types hold.
Regression watchThis diff can drop API pages from the static tree or throw while the enum list renders. Watch API-path 404s and errors on API URLs. Current 404 hot spots are api/alerts, api/organizations, and api/events. A jump on all api paths is the regression. Those three paths holding is not proof the change worked.
If the 404 rate rises, check whether whole api category pages are missing. That pattern means the OpenAPI tree did not build. Not observableThe cidr and not_cidr text on the API pages is not in telemetry. The prior-day error count with the exact url /api/ filter was not measured. The 48h error query used a different URL pattern. |
No description provided.