Make entity fields required by default #81
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 changes how grape-swagger-entity determines if an entity field is required or not:
documentation: { required: true/false }
is set, use thatif
orunless
is not null, assume the parameter is not requiredThis is consistent with how grape-entity renders fields: fields are always exposed unless
if
orunless
is provided (cf. https://github.com/ruby-grape/grape-entity?tab=readme-ov-file#conditional-exposure).Closes #80.
This is probably a breaking change, so I understand if you don't want to merge this as is, but it would be nice to be able to opt into this behavior.