Add OpenAPIOptions controls to hide routes and suppress default error responses#55
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds an explicit opt-out mechanism for framework-generated default error responses in the generated OpenAPI spec, allowing “no error contract” endpoints (e.g., health checks) to document only their success response.
Changes:
- Treat
OpenAPIOptions.Errors: []any{}(non-nil, length 0) as a signal to suppress all default error responses in the OpenAPI spec. - Update OpenAPI generation to honor this opt-out for the legacy
4XXcatch-all and default400/422/404responses. - Document the behavior in the README and add regression tests covering nil vs empty vs nil-only
Errorsslices.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Documents the new “explicit empty Errors slice” opt-out behavior and clarifies nil vs empty semantics. |
| fiberoapi.go | Implements suppression of default OpenAPI error responses when Errors is explicitly empty. |
| custom_errors_test.go | Adds tests validating suppression behavior and preserving backward compatibility for nil and nil-only slices. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Adds two new OpenAPIOptions fields: