Allow empty model definitions for Swagger 2.0 #963
Conversation
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
This commit relaxes a validation check that prevented the creation of an empty definitions or properties object in the Swagger 2.0 schema. The previous behavior would raise a GrapeSwagger::Errors::SwaggerSpec exception when a model, such as an entity with only hidden properties, resulted in an empty definition. This new behavior is more in line with the Swagger specification, which does not forbid such schemas. The fix involves removing the redundant if properties&.any? check and its associated error, allowing the parser to correctly build an empty but valid model.
Here's an example of a CHANGELOG.md entry: * [#963](https://github.com/ruby-grape/grape-swagger/pull/963): Allow empty model definitions for swagger 2.0 - [@numbata](https://github.com/numbata).Generated by 🚫 Danger |
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 PR fixes a GrapeSwagger::Errors::SwaggerSpec error that occurred when attempting to generate a Swagger 2.0 schema for an entity with no exposed properties.
The Swagger 2.0 specification does not explicitly forbid empty schemas. This change aligns the gem's behavior with the specification by removing a self-imposed validation that raised an error for empty models
Fixes #962