Skip to content

CLOUDP-304960: Errors (APIs must return ApiError when errors occur) #630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Mar 28, 2025
Merged

CLOUDP-304960: Errors (APIs must return ApiError when errors occur) #630

merged 11 commits into from
Mar 28, 2025

Conversation

@yelizhenden-mdb
Copy link
Collaborator

@yelizhenden-mdb yelizhenden-mdb commented Mar 27, 2025 •
edited
Loading

Proposed changes

Jira ticket: CLOUDP-304960
Implements xgen-IPA-114-error-responses-refer-to-api-error IPA rule.
Found 3 violations to fix

APIs must return ApiError when errors occur

      ##### Implementation details
      This rule checks that all 4xx and 5xx error responses reference the ApiError schema.

Checklist

  • I have signed the MongoDB CLA
  • I have added tests that prove my fix is effective or that my feature works

Changes to Spectral

  • I have read the README file for Spectral Updates

Further comments

@yelizhenden-mdb yelizhenden-mdb marked this pull request as ready for review March 27, 2025 17:55
@yelizhenden-mdb yelizhenden-mdb requested a review from a team as a code owner March 27, 2025 17:55
@yelizhenden-mdb yelizhenden-mdb marked this pull request as draft March 27, 2025 18:27
@yelizhenden-mdb yelizhenden-mdb marked this pull request as ready for review March 28, 2025 09:14
lovisaberggren
lovisaberggren approved these changes Mar 28, 2025
View reviewed changes
@yelizhenden-mdb yelizhenden-mdb merged commit 27d5f02 into main Mar 28, 2025
8 checks passed
@yelizhenden-mdb yelizhenden-mdb deleted the CLOUDP-304960 branch March 28, 2025 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lovisaberggren lovisaberggren lovisaberggren approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@yelizhenden-mdb @lovisaberggren