Repository navigation
Bump API schema to 377fc3e1 - #19869
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 change adds two experimental API reference pages for starring a service span. The plan checks those page loads, other API page loads, and API not-found events. An issue escalates when API not-found events rise or API page loads fall. Monitoring in Services: Mention PlanWhat changedGenerated API reference pages now include Star a Service Span and Unstar a Service Span under Explore. Those routes did not exist on the previous OpenAPI snapshot. The sentry-docs service must deploy this change before the new pages are live. The develop-docs service also deploys this commit because it shares the src tree. That site does not render generated API reference pages. RiskA broken schema can fail static generation for every API reference page. Users then hit not-found events on API routes. A render defect in the shared API page component can fail every endpoint page. The new experimental pages can fail alone if their markdown or parameters are invalid. Intended effectThe new pages are live when
Regression watchThis schema rebuild can drop existing API reference pages if generation throws. It can also 404 Explore routes if slugify of the new names collides. Watch API not-found events and existing API page loads on the same path. Watch production error events. A new client exception from the API page component is in scope. Algolia insights fetch failures already occur and are not this change.
Not observablePage HTML text for Star a Service Span is not in telemetry. Pageload latency for API docs URLs was not isolated. Catch-all transaction names mix those routes with other pages. The develop-docs site does not render generated API reference pages, so that ship cannot confirm intended effect. Hourly error events for develop-docs were not sampled. |
|
Verified in
|
No description provided.