Repository navigation
Bump API schema to 1ef2ab27 - #20104
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 reference page loads, API 404s, and client errors on those pages. An issue escalates when API page loads fall or those 404s and errors rise. Services: PlanWhat changedThe API reference page for Retrieve an Organization's AI Conversation now documents three new cost fields. Those fields are cacheReadCost, cacheWriteCost, and reasoningCost on stats and usageByModel. The page path is /api/explore/retrieve-an-organizations-ai-conversation/. sentry-docs must deploy before this content is live. The build fetches OpenAPI SHA 1ef2ab2770f6c455aec8462cf284008426679e42 and prebuilds static pages. develop-docs also rebuilds shared src. That site does not serve API reference pages. RiskA broken schema can drop API reference pages from the static build. Users then see 404s on /api/ routes, especially /api/explore/. An unexpected schema shape can also throw in the shared API page renderer. Intended effectThis change updates documented response fields. Production metrics cannot show those field names on the live page. Treat intended_effect as unknown from telemetry. absent looks like the live page still omits cacheReadCost, cacheWriteCost, and reasoningCost. The changed page had no measured docs.page.load events in the sampled 24h window. Regression watchA bad schema would first show as missing API pages or new client errors on /api/ paths. Watch the whole API section and the explore slice. The changed endpoint itself has no load traffic to watch.
Not observableThe live HTML for the new cost field names is not in Sentry. The changed endpoint had zero docs.page.load events, so a break of only that page may not move API page loads. A pageload trace query for /api/explore/ timed out. develop-docs has no API reference page signals. |
Co-authored-by: sentry-api-schema-updater[bot] <271575301+sentry-api-schema-updater[bot]@users.noreply.github.com>
No description provided.