docs: GET /api/artists/{id}/segments (replaces /api/artist/segments)

[arpitgupta1214]

Summary

• Adds GET /api/artists/{id}/segments as a new nested-resource list endpoint (artist id is path-encoded; page / limit remain as query params with the same defaults)
• Removes the legacy GET /api/artist/segments reference in the same PR
• Swaps the Artists navigation entry in docs.json from api-reference/artist/segments to api-reference/artists/segments

The accompanying api PR introduces the nested route and removes the legacy route at the same time; chat is the only known consumer today.

Changes

• api-reference/artists/segments.mdx (added) — frontmatter-only page referencing the new operation, matching the pattern used by artists/pin.mdx, artists/unpin.mdx, artists/delete.mdx
• api-reference/artist/segments.mdx (removed)
• api-reference/openapi/releases.json:
  • adds GET /api/artists/{id}/segments with the id path param (uuid), page / limit query params, and 200 / 400 / 401 / 403 / 500 responses
  • reuses existing ArtistSegmentsResponse and ArtistSegmentsErrorResponse schemas so the published payload shape is identical to the legacy route
  • removes the legacy GET /api/artist/segments path
• docs.json — navigation swap (no other nav changes)

Test plan

• npx mintlify@latest dev renders the Artists group with the new "Get Artist Segments" page at api-reference/artists/segments
• The new page shows the id path param and both page / limit query params
• api-reference/artist/segments is gone from navigation and returns 404 locally
• releases.json still parses and no references to /api/artist/segments remain
• Hold merge until the matching api PR (which cuts over the actual route) is ready so the docs stay consistent with what the API serves

---

Summary by cubic

Adds docs and OpenAPI for GET /api/artists/{id}/segments and removes the legacy /api/artist/segments. Moves to a nested, resource-first path. Pagination stays the same and response schemas are unchanged.

• Migration
  • OpenAPI: adds the new path with an id path param, keeps page/limit, and defines 200/400/401/403/500. Reuses existing ArtistSegmentsResponse and ArtistSegmentsErrorResponse.
  • Docs: new page at api-reference/artists/segments; old page removed; navigation updated.
  • No alias for the legacy route. Coordinate merge with the API PR that drops the old path.

^{Written for commit dc17cca. Summary will update on new commits.}

Summary by CodeRabbit

• Documentation

  • Updated API reference documentation for artist segments endpoint with improved error response documentation including authorization and server error scenarios.

• API Changes

  • Restructured artist segments endpoint path and parameter format for improved API consistency and clarity.

[coderabbitai]

📝 Walkthrough

Walkthrough

API documentation for artist segments was migrated from a singular endpoint structure (/api/artist/segments) to a plural, path-parameterized structure (/api/artists/{id}/segments). The change includes relocating documentation files, updating the OpenAPI specification with new response codes and error schemas, and updating navigation references.

Changes

Cohort / File(s)	Summary
Documentation Files api-reference/artist/segments.mdx, api-reference/artists/segments.mdx	Removed old documentation page for singular endpoint and added new documentation page for plural endpoint with pagination support description.
OpenAPI Specification api-reference/openapi/releases.json	Updated endpoint from GET /api/artist/segments (query-based artist_account_id) to GET /api/artists/{id}/segments (path-based id parameter). Added 401, 403, and 500 response documentation with ArtistSegmentsErrorResponse schema references.
Navigation Configuration docs.json	Updated Artists tab navigation route reference from api-reference/artist/segments to api-reference/artists/segments.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• refactor: split openapi.json into 5 domain-specific specs #121: Related through overlapping changes to the artist segments endpoint documentation and OpenAPI specification in the releases domain.

Suggested reviewers

• sweetmantech

Poem

🐰 A plural path now guides the way,
From /artist to /artists/ we say!
With IDs nested, responses complete,
Documentation moves to plural feet! 🎉

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: migrating from GET /api/artist/segments to GET /api/artists/{id}/segments with proper path parameter handling.
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 feat/docs-get-artists-segments

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[cubic-dev-ai]

No issues found across 4 files