Skip to content

CONV-316: Document standard API errors#277

Merged
menvil merged 1 commit into
developfrom
feature/CONV-316-document-standard-api-errors
Jun 3, 2026
Merged

CONV-316: Document standard API errors#277
menvil merged 1 commit into
developfrom
feature/CONV-316-document-standard-api-errors

Conversation

@menvil

@menvil menvil commented Jun 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds ErrorResponse and ErrorObject schemas with all standard error codes
  • Adds reusable UnauthorizedError, ValidationError, NotFoundError response components
  • Documents 10 machine-readable error codes in ErrorObject.code description

Test plan

  • Test written first — fails before schemas added
  • composer test passes (605 tests)

🤖 Generated with Claude Code


Summary by cubic

Standardize API error responses in the OpenAPI spec so clients can rely on consistent, machine-readable codes. Addresses Linear CONV-316.

  • New Features
    • Added ErrorResponse and ErrorObject schemas with code, message, and details.
    • Documented 10 error codes for common failure cases.
    • Added reusable responses: UnauthorizedError, ValidationError, NotFoundError.
    • Expanded ApiKeyBearer description with an example Authorization header.

Written for commit 9edbbe0. Summary will update on new commits.

Review in cubic

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@menvil menvil merged commit d1f9066 into develop Jun 3, 2026
1 check was pending
@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are limited based on label configuration.

🏷️ Required labels (at least one) (1)
  • release

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: baa1e322-f2f2-4e61-b560-bf8b1bef8e8e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/CONV-316-document-standard-api-errors

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.

@menvil menvil deleted the feature/CONV-316-document-standard-api-errors branch June 3, 2026 17:11
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