Skip to content

Conversation

@sfanahata
Copy link
Contributor

DESCRIBE YOUR PR

We are EOLing test analytics, and therefore removing it from docs.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline: Feb 10
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@vercel
Copy link

vercel bot commented Jan 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
develop-docs Ready Ready Preview, Comment Jan 26, 2026 9:44pm
sentry-docs Ready Ready Preview, Comment Jan 26, 2026 9:44pm

Request Review

Shannon Anahata and others added 2 commits January 26, 2026 13:17
Adds filtering logic to exclude endpoints with "(DEPRECATED)" in their
operationId from being included in the generated API documentation. This
prevents 404 errors when pages link to these deprecated endpoints.

The deprecated endpoints in the OpenAPI spec direct users to newer
replacement endpoints, so they shouldn't have dedicated documentation pages.

Fixes broken links to:
- /api/alerts/deprecated-update-a-metric-alert-rule
- /api/alerts/deprecated-update-an-issue-alert-rule

Co-Authored-By: Claude <noreply@anthropic.com>
Combines test analytics removal with deprecated endpoint filtering to fix 404s.
@sfanahata
Copy link
Contributor Author

Updated: Now includes deprecated API endpoint fix

This PR now also includes the fix for deprecated API endpoints to prevent 404 errors.

Additional Changes

  • Added filtering logic in src/build/resolveOpenAPI.ts to skip endpoints with "(DEPRECATED)" in their operationId
  • Fixes 404 errors for:
    • /api/alerts/deprecated-update-a-metric-alert-rule
    • /api/alerts/deprecated-update-an-issue-alert-rule
    • All other deprecated endpoints in the OpenAPI schema

This consolidates both fixes into a single PR since they were dependent on each other.

@sfanahata sfanahata merged commit 45af3a8 into master Jan 26, 2026
15 checks passed
@sfanahata sfanahata deleted the remove-test-analytics-doc branch January 26, 2026 21:52
@sfanahata sfanahata restored the remove-test-analytics-doc branch January 27, 2026 18:00
@sfanahata sfanahata deleted the remove-test-analytics-doc branch January 27, 2026 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants