Suppress 4XX catch-all response for explicit error codes#54
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refines OpenAPI spec generation for error responses by suppressing the legacy 4XX catch-all response when a route explicitly declares per-status errors via OpenAPIOptions.Errors, while keeping the 4XX catch-all for backward compatibility when no explicit errors are provided.
Changes:
- Update spec generation to only emit the legacy
4XXcatch-all whenTErroris non-empty and no explicitOpenAPIOptions.Errorsare provided. - Document the updated behavior in
README.md. - Add tests covering both the suppression case and the backward-compatible legacy case.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Documents that 4XX is omitted once per-status Errors are declared. |
| fiberoapi.go | Suppresses the legacy 4XX response when explicit per-status errors are present. |
| custom_errors_test.go | Adds tests ensuring 4XX is suppressed with explicit errors and preserved without them. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…penAPI spec generation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the OpenAPI spec generation logic to better handle how error responses are documented, particularly regarding the legacy 4XX catch-all response versus explicit error status codes. The changes clarify and enforce that when explicit error codes are provided, the generic 4XX catch-all is omitted, resulting in a more accurate and less confusing API specification. Additionally, new tests ensure this behavior is correct and maintains backward compatibility.
OpenAPI error response handling:
fiberoapi.go) now omits the legacy 4XX catch-all response when explicit error codes are provided viaOpenAPIOptions.Errors, ensuring only the enumerated status codes appear in the spec. If no explicit errors are declared and a non-emptyTErroris present, the 4XX catch-all is still emitted for backward compatibility.README.md) is updated to explain the new behavior: the 4XX catch-all is suppressed when explicit errors are declared, and only those status codes appear in the spec.Testing and validation:
custom_errors_test.go: