docs(docs): migrate GET /api/accounts/{id}/catalogs by arpitgupta1214 · Pull Request #153 · recoupable/docs

arpitgupta1214 · 2026-04-21T19:24:04Z

Replace legacy GET /api/catalogs operation with GET /api/accounts/{id}/catalogs on recoup-api.vercel.app; account id moves from query to path; drop unused POST/DELETE entries.

Test plan

Mintlify preview renders the migrated page with recoup-api.vercel.app and {id} path param
Response codes list 200, 400, 401, 403, 404, 500
Legacy /api/catalogs path key absent from releases.json

Summary by CodeRabbit

API Updates
- Catalogs endpoint restructured to /api/accounts/{id}/catalogs with account ID as a required path parameter
- Removed POST and DELETE operations from this endpoint
- Updated error response documentation and response descriptions

Move the account id from a query param to a path segment on the GET operation, drop the per-operation api.recoupable.com servers override so the page renders against recoup-api.vercel.app, and enumerate the full response code set the new handler emits (200, 400, 401, 403, 404, 500). POST and DELETE overrides stay on the legacy /api/catalogs path until their own migrations land.

coderabbitai · 2026-04-21T19:24:47Z

📝 Walkthrough

Walkthrough

The catalogs API path was changed from /api/catalogs to /api/accounts/{id}/catalogs, moving the account identifier from a required query parameter to a required path parameter; OpenAPI and MDX docs were updated and the separate create/delete catalog docs/pages were removed or adjusted.

Changes

Cohort / File(s)	Summary
OpenAPI Specification `api-reference/openapi/releases.json`	Replaced `/api/catalogs` with `/api/accounts/{id}/catalogs`. Moved `account_id` from required query to required path param `id` (UUID). Removed `post`/`delete` operations for this path. Updated GET error responses (added/changed `401`, `403`, `500`; revised `404` and `400` wording).
Docs — Catalogs MDX `api-reference/songs/catalogs.mdx`	Frontmatter changed from unquoted `get /api/catalogs` to OpenAPI reference `/api-reference/openapi/releases.json GET /api/accounts/{id}/catalogs`; removed note about POST/DELETE capabilities.
Docs — Removed Create/Delete pages `api-reference/songs/catalogs-create.mdx`, `api-reference/songs/catalogs-delete.mdx`	Deleted MDX pages/frontmatter and explanatory notes for creating and deleting catalogs (these docs removed from navigation).
Documentation Index `docs.json`	Removed references to the now-removed `catalogs-create` and `catalogs-delete` pages from the Releases → Songs & Catalogs navigation.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

docs: rename /api/artist/socials → /api/artists/{id}/socials #142: Performs similar endpoint refactor moving an identifier from query param to path param and updating OpenAPI/MDX references.
refactor: split openapi.json into 5 domain-specific specs #121: Overlaps with OpenAPI/MDX reference restructuring and splitting of domain OpenAPI entries affecting MDX mappings.

Suggested reviewers

sweetmantech

Poem

🐰 I hopped through JSON, changed a route,
Moved the id to where it's about,
Docs trimmed tidy, pages fell away,
Accounts now lead the catalog way,
A small rabbit cheer to mark the day! 🎈

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the primary change: migrating the GET endpoint from /api/catalogs to /api/accounts/{id}/catalogs, which is the core focus of the changeset.

_{✏️ 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/account-catalogs-migration-docs

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.}

cubic-dev-ai

1 issue found across 1 file

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="api-reference/openapi/releases.json">
<violation number="1" location="api-reference/openapi/releases.json:854">
P1: The Get Catalogs MDX page still references `get /api/catalogs`, but this PR moves that operation to `/api/accounts/{id}/catalogs`. Update the MDX `openapi` target to the new path to avoid a broken API reference page.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

…catalogs path The releases.json no longer exposes GET /api/catalogs after migration, so the page was rendering empty. Update the frontmatter to reference the new account-scoped path in releases.json.

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@api-reference/openapi/releases.json`:
- Around line 853-854: Re-add the legacy path key "/api/catalogs" to the OpenAPI
spec in releases.json containing only the post and delete operations (preserve
their operation definitions and schemas as they were) so
api-reference/songs/catalogs-create.mdx and catalogs-delete.mdx find matching
operations; do not reintroduce GET (since that moved to
"/api/accounts/{id}/catalogs"), ensure the operationId, requestBody, parameters
and responses for POST and DELETE match the original definitions so Mintlify can
auto-generate the request/response sections for those docs.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 29c8d05a-25ec-46d4-b02a-5f48fb53e6ee

📥 Commits

Reviewing files that changed from the base of the PR and between ea3c08a and 2bb54c3.

📒 Files selected for processing (2)

api-reference/openapi/releases.json
api-reference/songs/catalogs.mdx

coderabbitai · 2026-04-21T19:57:44Z

 },
- "/api/catalogs": {
+ "/api/accounts/{id}/catalogs": {


⚠️ Potential issue | 🔴 Critical
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Confirm that no /api/catalogs path key remains and that the MDX pages still reference it.echo"=== /api/catalogs occurrences in releases.json ===" rg -n '"/api/catalogs"' api-reference/openapi/releases.json ||echo"(none — legacy path fully removed)"echoecho"=== MDX pages still referencing legacy /api/catalogs ===" rg -n --type=md --type-add 'mdx:*.mdx' --type=mdx '^openapi:.*\b/api/catalogs\b' api-reference ||true
Repository: recoupable/docs
Length of output: 202
🏁 Script executed:
#!/bin/bash# Find the actual MDX files and check their contentecho"=== Locating catalogs-create.mdx ===" fd -name "catalogs-create.mdx" api-reference echoecho"=== Locating catalogs-delete.mdx ===" fd -name "catalogs-delete.mdx" api-reference echoecho"=== Locating all catalogs-related mdx files ===" fd -name "*catalogs*.mdx" api-reference
Repository: recoupable/docs
Length of output: 892
🏁 Script executed:
#!/bin/bash# Find the actual MDX files and check their contentecho"=== Locating catalogs-related mdx files ===" fd "catalogs.*\.mdx" api-reference echoecho"=== Searching for any mdx files in api-reference ===" fd "\.mdx$" api-reference | head -20
Repository: recoupable/docs
Length of output: 974
🏁 Script executed:
#!/bin/bashecho"=== Content of catalogs-create.mdx ===" cat api-reference/songs/catalogs-create.mdx echoecho"=== Content of catalogs-delete.mdx ===" cat api-reference/songs/catalogs-delete.mdx echoecho"=== Content of catalogs.mdx ===" cat api-reference/songs/catalogs.mdx
Repository: recoupable/docs
Length of output: 1106
🏁 Script executed:
#!/bin/bash# Check what operations exist on /api/accounts/{id}/catalogs in releases.jsonecho"=== Checking /api/accounts/{id}/catalogs operations ===" rg -A 200 '"/api/accounts/\{id\}/catalogs"' api-reference/openapi/releases.json | head -250
Repository: recoupable/docs
Length of output: 6431
🏁 Script executed:
#!/bin/bash# Search for POST and DELETE operations on the accounts catalogs pathecho"=== Searching for POST on catalogs path ===" rg -n '"post"' api-reference/openapi/releases.json | grep -i catalog echoecho"=== Searching for DELETE on catalogs path ===" rg -n '"delete"' api-reference/openapi/releases.json | grep -i catalog echoecho"=== Full /api/catalogs search ===" rg -n '/api/catalogs' api-reference/openapi/releases.json echoecho"=== Check if /api/accounts/{id}/catalogs has more than just get ===" sed -n '/\/api\/accounts\/\{id\}\/catalogs/,/^ "\/api\//p' api-reference/openapi/releases.json | head -50
Repository: recoupable/docs
Length of output: 359
🏁 Script executed:
#!/bin/bash# Final verification: check releases.json structure around accounts catalogs to confirm only GET existsecho"=== Lines 850-900 of releases.json showing /api/accounts/{id}/catalogs ===" sed -n '850,900p' api-reference/openapi/releases.json
Repository: recoupable/docs
Length of output: 1696
Removing the /api/catalogs path key breaks the Create Catalogs and Delete Catalogs doc pages.
This PR drops the entire /api/catalogs path key from releases.json, but api-reference/songs/catalogs-create.mdx still has openapi: post /api/catalogs and api-reference/songs/catalogs-delete.mdx still has openapi: delete /api/catalogs. With no matching operation in any mounted spec, Mintlify will render those two pages with only the title/description and no auto-generated request/response section — the exact failure mode that motivated commit 3 for catalogs.mdx.
The PR description also explicitly states POST and DELETE should remain on the legacy path until their own migrations land, so this removal appears unintended.
The new /api/accounts/{id}/catalogs path only includes the GET operation; POST and DELETE are entirely missing from the spec.
Two options to unbreak those pages before merge:
Re-add the legacy /api/catalogs key with only the post and delete operations preserved (keep GET removed since it has moved).
Migrate catalogs-create.mdx and catalogs-delete.mdx to reference the new account-scoped paths in the same PR (requires server-side routes to exist for POST/DELETE).
Option 1 matches the stated merge plan most closely.
🔧 Proposed fix — restore legacy path with POST/DELETE only
+ "/api/catalogs": {+ "post": { /* preserved POST operation spec */ },+ "delete": { /* preserved DELETE operation spec */ }+ }, "/api/accounts/{id}/catalogs": { "get": {
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@api-reference/openapi/releases.json` around lines 853 - 854, Re-add the legacy path key "/api/catalogs" to the OpenAPI spec in releases.json containing only the post and delete operations (preserve their operation definitions and schemas as they were) so api-reference/songs/catalogs-create.mdx and catalogs-delete.mdx find matching operations; do not reintroduce GET (since that moved to "/api/accounts/{id}/catalogs"), ensure the operationId, requestBody, parameters and responses for POST and DELETE match the original definitions so Mintlify can auto-generate the request/response sections for those docs.

These MDX pages referenced the legacy /api/catalogs POST/DELETE operations that were removed from releases.json. The verbs have no live caller and are not scheduled for migration. Also drop the Note callout on the Get Catalogs page referencing them.

arpitgupta1214 · 2026-04-21T21:08:23Z

Mintlify preview — GET /api/accounts/{id}/catalogs

Captured from a local npx mintlify@latest dev on commit 98d7ecb. Shows:

Path GET /api/accounts/{id}/catalogs with {id} as a required UUID path parameter
Server inherited from top-level: recoup-api.vercel.app
Response codes 200 / 400 / 401 / 403 / 404 / 500
Response shape { status, catalogs: [{ id, name, created_at, updated_at }], error }
Sidebar no longer lists the removed POST Create Catalogs / DEL Delete Catalogs pages; the Note callout referencing them on this page was also dropped.

Rolling comment — will be replaced on further changes and the preview-assets branch deleted on merge.

arpitgupta1214 requested a review from sweetmantech as a code owner April 21, 2026 19:24

cubic-dev-aiBot reviewed Apr 21, 2026
View reviewed changes

Comment threadapi-reference/openapi/releases.json

arpitgupta1214 added 2 commits April 22, 2026 01:20

docs: remove legacy /api/catalogs path key entirely
b937301

fix(catalogs): point Get Catalogs MDX to migrated /api/accounts/{id}/…
2bb54c3
…catalogs path The releases.json no longer exposes GET /api/catalogs after migration, so the page was rendering empty. Update the frontmatter to reference the new account-scoped path in releases.json.

coderabbitaiBot reviewed Apr 21, 2026
View reviewed changes

arpitgupta1214 changed the title ~~docs: migrate GET /api/catalogs → /api/accounts/{id}/catalogs~~docs(docs): migrate GET /api/accounts/{id}/catalogsApr 22, 2026

sweetmantech approved these changes Apr 23, 2026
View reviewed changes

sweetmantech merged commit a4ecdb8 into mainApr 23, 2026
3 checks passed

sweetmantech mentioned this pull request Apr 23, 2026
Promote test to main recoupable/app#1699
Merged

coderabbitaiBot mentioned this pull request Apr 23, 2026
docs(docs): remove GET /api/subscriptions endpoint #159
Merged
3 tasks

sidneyswift mentioned this pull request May 6, 2026
docs: combined overhaul — brand, MCP, content cleanup, onboarding, skills, nav (PRs #168, #170-174) #189
Open

coderabbitaiBot mentioned this pull request Jun 18, 2026
docs: POST /api/catalogs create-catalog contract #243
Merged

Navigation Menu

Uh oh!

docs(docs): migrate GET /api/accounts/{id}/catalogs - #153

docs(docs): migrate GET /api/accounts/{id}/catalogs#153
sweetmantech merged 4 commits into
mainfrom
feat/account-catalogs-migration-docs

arpitgupta1214 commented Apr 21, 2026•
edited
Loading

Uh oh!

coderabbitaiBot commented Apr 21, 2026•
edited
Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

cubic-dev-aiBot left a comment

Uh oh!

Uh oh!

coderabbitaiBot left a comment

Uh oh!

coderabbitaiBotApr 21, 2026

Uh oh!

arpitgupta1214 commented Apr 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

arpitgupta1214 commented Apr 21, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test plan

Summary by CodeRabbit

Uh oh!

coderabbitaiBot commented Apr 21, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

cubic-dev-aiBot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitaiBot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitaiBotApr 21, 2026

Choose a reason for hiding this comment

Uh oh!

arpitgupta1214 commented Apr 21, 2026

Mintlify preview — GET /api/accounts/{id}/catalogs

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

arpitgupta1214 commented Apr 21, 2026•
edited
Loading

coderabbitaiBot commented Apr 21, 2026•
edited
Loading