Repository navigation
docs(api): mark the metrics api as deprecated - #4855
Merged
Merged
Conversation
Contributor
Author
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Every page under /docs/api-reference/metrics-api and /docs/api-reference/webhook-api shows a deprecation notice with the deprecation, sunset and decommission dates. The API Reference nav marks both APIs Deprecated.
devin-ai-integration
Bot
force-pushed
the
devin/1793920720-deprecate-metrics-webhooks
branch
from
November 5, 2026 23:29
b940abe to
d623e7f
Compare
Only the Metrics API is deprecated for now.
devin-ai-integration
Bot
changed the title
jasonatran
marked this pull request as ready for review
November 6, 2026 02:36
Co-authored-by: jasonatran <5642477+jasonatran@users.noreply.github.com>
jasonatran
approved these changes
Nov 6, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Every page under
/docs/api-reference/metrics-apinow shows a "Deprecated" warning callout at the top with the dates:The endpoint pages come from
yarn build:remote(fumadocs-openapi) and are gitignored, so the banner is not in the MDX. The docs page (app/docs/[...slug]/page.tsx) rendersApiDeprecationNoticewhengetApiDeprecation(page.slugs)matches a prefix inAPI_DEPRECATIONS(lib/api-deprecations.ts). That covers both the hand-written pages and the generated ones. To change a date or deprecate another API, edit that list.Also:
apiReferenceOptions) gives the Metrics API the existingDeprecatedbadge (the docs subnav already styles it), and its description starts with "Deprecated:".meta.jsondescription starts with "Deprecated:".The Webhooks API is not deprecated in this PR. Its pages and nav entry are unchanged.
Not changed: other docs that mention the Metrics API (e.g.
data-api/index.mdx, the Avalanche SDK chainkit pages), and the Console's Data API keys copy.Checks:
tsc --noEmit, a new unit testtests/unit/docs/api-deprecations.test.ts, and checked locally afteryarn build:remote: the Metrics API pages show the banner and the Webhooks API pages don't.Link to Devin session: https://app.devin.ai/sessions/7b2f65befed24b7fabed525145f4670d
Open in Devin Desktop: https://app.devin.ai/desktop/session/7b2f65befed24b7fabed525145f4670d?variant=devin