Skip to content

docs(organizations): member/domain error envelope is {status, error}#263

Merged
sweetmantech merged 1 commit into
mainfrom
docs/org-error-envelope
Jul 3, 2026
Merged

docs(organizations): member/domain error envelope is {status, error}#263
sweetmantech merged 1 commit into
mainfrom
docs/org-error-envelope

Conversation

@sweetmantech

@sweetmantech sweetmantech commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

What

Reconciles the contract with reality after api#749's review round converged the members+domains endpoints on the shared errorResponse helper:

  • New ErrorEnvelope schema: {status: "error", error: string}
  • All 16 error responses (400/401/403/409) across the five member/domain operations repointed to it
  • Also closes the long-standing 401 drift: 401s always emitted error (shared validateAuthContext), but were documented as message
  • The pre-existing artists endpoint keeps OrganizationsErrorResponse (message) — that is what its handler actually emits

Tracking: chat#1841. Merge after api#749 (contract follows the implementation in this reconcile step).

🤖 Generated with Claude Code


Summary by cubic

Aligns org members/domains API docs with the implementation by adding a shared ErrorEnvelope schema {status: "error", error} and pointing all 400/401/403/409 responses to it. Fixes the 401 mismatch (docs said message; API returns error); the artists endpoint stays on OrganizationsErrorResponse {status, message}.

Written for commit d03b099. Summary will update on new commits.

Review in cubic

…tatus, error}

The api converged these endpoints' error paths on the shared
errorResponse helper (recoupable/api#749), which emits
{status:"error", error} — the same shape validateAuthContext's 401s
always had. New ErrorEnvelope schema; the 16 error responses across
the five member/domain operations now reference it. The pre-existing
artists endpoint keeps OrganizationsErrorResponse ({status, message}),
which is what it actually emits.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@sweetmantech, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 24 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a511b7a1-f5ed-4dc2-a190-1842d036537f

📥 Commits

Reviewing files that changed from the base of the PR and between 981524c and d03b099.

📒 Files selected for processing (1)
  • api-reference/openapi/accounts.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/org-error-envelope

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.

@mintlify

mintlify Bot commented Jul 3, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
recoup-docs 🟢 Ready View Preview Jul 3, 2026, 7:09 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 1 file

Re-trigger cubic

@sweetmantech sweetmantech merged commit 8c115d9 into main Jul 3, 2026
3 checks passed
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.

1 participant