docs(docs): remove GET /api/subscriptions endpoint#159
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
💤 Files with no reviewable changes (3)
📝 WalkthroughWalkthroughThe OpenAPI spec and docs remove the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
api-reference/openapi/accounts.json (1)
357-450: LGTM — migration is clean and consistent.The new
/api/accounts/{id}/subscriptionoperation correctly:
- Uses a required UUID path param
idwith matching schema conventions (mirrors/api/accounts/{id}at lines 17–55).- Drops the per-operation
serversoverride so the roothttps://recoup-api.vercel.appserver is inherited.- Documents operation-level
apiKeyAuthandbearerAuthconsistent with other authenticated endpoints in this file.- Enumerates 200/400/401/403/404/500 with
SubscriptionErrorResponserefs that resolve to the schema at line 2833.Minor nit (optional): the 400 description at line 399 says "invalid or missing
idpath parameter format". Sinceidis a required path parameter, a "missing" id cannot reach the handler (it would be a 404 routing mismatch). Consider simplifying to just "invalididUUID format".🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@api-reference/openapi/accounts.json` around lines 357 - 450, Update the 400 response description for the GET operation on "/api/accounts/{id}/subscription": remove the phrase about a "missing" id since the path param is required and missing id would not reach the handler; change the description to something like "Bad request - invalid `id` UUID format" in the 400 response block for that operation to reflect the correct validation case.
🤖 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/subscriptions/get.mdx`:
- Around line 2-3: The page title "Get Subscriptions" is plural but the
operation is account-scoped; update the frontmatter title value (the title: 'Get
Subscriptions' string) to a singular, self-describing title such as "Get
Subscription" or "Get Account Subscription" so the sidebar and search reflect
the single-resource endpoint for GET /api/accounts/{id}/subscription.
---
Nitpick comments:
In `@api-reference/openapi/accounts.json`:
- Around line 357-450: Update the 400 response description for the GET operation
on "/api/accounts/{id}/subscription": remove the phrase about a "missing" id
since the path param is required and missing id would not reach the handler;
change the description to something like "Bad request - invalid `id` UUID
format" in the 400 response block for that operation to reflect the correct
validation case.
🪄 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: ede0651b-0874-41dd-a723-ec4d39f9e043
📒 Files selected for processing (2)
api-reference/openapi/accounts.jsonapi-reference/subscriptions/get.mdx
There was a problem hiding this comment.
1 issue found across 1 file (changes from recent commits).
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/accounts.json">
<violation number="1" location="api-reference/openapi/accounts.json:364">
P2: `GET /api/accounts/{id}/subscription` is missing operation-level auth requirements, so the OpenAPI contract now marks it as unauthenticated.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| "in": "query", | ||
| "name": "id", | ||
| "in": "path", | ||
| "description": "The unique identifier of the account to query", |
There was a problem hiding this comment.
P2: GET /api/accounts/{id}/subscription is missing operation-level auth requirements, so the OpenAPI contract now marks it as unauthenticated.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At api-reference/openapi/accounts.json, line 364:
<comment>`GET /api/accounts/{id}/subscription` is missing operation-level auth requirements, so the OpenAPI contract now marks it as unauthenticated.</comment>
<file context>
@@ -357,19 +357,11 @@
"name": "id",
"in": "path",
- "description": "The unique identifier (UUID) of the account to query",
+ "description": "The unique identifier of the account to query",
"required": true,
"schema": {
</file context>
No monorepo caller hits this endpoint — chat's dead helper is being deleted (recoupable/chat#1703) and the replacement api route is dropped. Removing the path, mdx, nav entry, and orphaned response schemas.
e76ad2c to
0dd00c2
Compare
Summary
Removes the
GET /api/subscriptionsendpoint from the public API docs — no monorepo caller uses it and the api-side replacement is being dropped (recoupable/api#476 closed).Test plan
Subscriptionsnav group still showssessions-createaccounts.jsonvalidatesSummary by CodeRabbit
API Changes
Documentation