Skip to content

chore: remove dead segments surface#141

Merged
sweetmantech merged 2 commits into
mainfrom
chore/remove-segments-surface
Apr 17, 2026
Merged

chore: remove dead segments surface#141
sweetmantech merged 2 commits into
mainfrom
chore/remove-segments-surface

Conversation

@arpitgupta1214
Copy link
Copy Markdown
Collaborator

@arpitgupta1214 arpitgupta1214 commented Apr 16, 2026

Summary

  • Deletes api-reference/artist/segments.mdx, api-reference/chat/segment.mdx, api-reference/segment/fans.mdx
  • Drops nav entries in docs.json and renames the Fans & Segments group to Fans
  • Removes the /api/artist/segments, /api/segment/fans, and /api/chats/{id}/segment paths from the OpenAPI JSON along with the ArtistSegment*, SegmentFan*, and GetChatSegment* schemas no longer referenced by any remaining path
  • Updates quickstart.mdx and index.mdx LLM quick-reference lists to drop the removed endpoints

Context

The Segments surface is being removed entirely from chat, api, and docs. The earlier migration effort (docs #135, #136, api #443, #444, chat #1679, #1680) was abandoned and those PRs were closed unmerged.

Do not merge until chat and api cleanup PRs are merged, otherwise the published surface would briefly reference live endpoints that are about to disappear — or worse, remove docs for endpoints still being called.

Depends on:

Test plan

  • docs.json renders without broken links (Mintlify preview)
  • OpenAPI JSON files parse cleanly
  • Published reference surface no longer lists any /api/*segment* path

Deletes the three segments-related reference pages and their OpenAPI
definitions. The feature is being removed from chat and api entirely;
the earlier migration plan is abandoned. Part of
SEGMENTS_SURFACE_REMOVAL_PLAN.md.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 16, 2026

📝 Walkthrough

Walkthrough

This PR removes three segment-related API endpoints from the OpenAPI specifications (GET /api/artist/segments, GET /api/chats/{id}/segment, GET /api/segment/fans) and deletes their corresponding documentation pages, navigation entries, and quick reference descriptions. The DELETE /api/chats/{id} endpoint description is also updated to reflect narrower cascade behavior.

Changes

Cohort / File(s) Summary
OpenAPI Endpoint & Schema Removal
api-reference/openapi/releases.json, api-reference/openapi/research.json
Removed two endpoints (GET /api/artist/segments, GET /api/segment/fans) and associated response schemas from releases.json. Removed GET /api/chats/{id}/segment endpoint and response schemas from research.json. Updated DELETE /api/chats/{id} description to remove claims about cascade deletion of segment-room links and room-report links.
Documentation Page Frontmatter Removal
api-reference/artist/segments.mdx, api-reference/chat/segment.mdx, api-reference/segment/fans.mdx
Removed MDX frontmatter metadata (page titles and OpenAPI route references) from three documentation pages.
Navigation & Quick Reference Updates
docs.json, index.mdx, quickstart.mdx
Removed three documentation page entries from navigation structure in docs.json. Updated endpoint descriptions in quick reference guides to remove references to removed segment resources.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • docs#121: Refactor that moved and re-referenced segment-related endpoints in domain-specific OpenAPI specs, directly affected by the removal of those same endpoints and MDX files.
  • docs#90: PR that introduced the GET /api/chats/{id}/segment endpoint, now being reversed by this removal.

Suggested reviewers

  • sweetmantech

Poem

🐰 Segments segmented, now they fade away,
Three endpoints rest, no more to play,
Schemas simplified, docs cascade,
Clean slate emerges, oh what a parade! 🎉

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The PR title 'chore: remove dead segments surface' clearly and specifically describes the main change: removing documentation and API references for the segments feature.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/remove-segments-surface

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 8 files

Segments pages are removed from the group; rename to reflect the
remaining content.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sweetmantech sweetmantech merged commit 8113795 into main Apr 17, 2026
3 checks passed
@sweetmantech sweetmantech deleted the chore/remove-segments-surface branch April 17, 2026 01:07
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.

2 participants