Allow Proc for enum values in documentation #77
Merged
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
Enables the use of a Proc for the `values` option within
Grape::Entity documentation. This allows for dynamic generation of
enum values based on runtime logic when generating Swagger
specifications.
For example, this is useful when you want to specify a model's enum
for the `values` option and need to lazy-load the model, like this:
```ruby
expose :some, documentation: { values: -> { Model.some_enum.keys } }
```
This provides consistency, as Proc is also allowed for the `values`
option in request parameters:
https://github.com/ruby-grape/grape-swagger/blob/3e842a138b0f5edd2538d9da4aa23276e63e5d5c/lib/grape-swagger/doc_methods/parse_params.rb#L179-L180
krororo
force-pushed
the
allow-proc-for-values
branch
from
474d169 to
c5c122f
Compare
|
@numbata Want to help review this? |
numbata
reviewed
Apr 23, 2025
| when Array | ||
| type[:enum] = values | ||
| when Proc | ||
| type[:enum] = values.call |
There was a problem hiding this comment.
Should we have an extra check that the `.call' returns an array? To avoid any surprises in the schema. wdyt?
There was a problem hiding this comment.
@numbata Thanks for the review.
I've fixed it to check if the return value of Proc is an Array.
|
Cut a release. If anyone wants to do more work this gem could use some active maintainers. There are some issues that look interesting. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Enables the use of a Proc for the
valuesoption within Grape::Entity documentation. This allows for dynamic generation of enum values based on runtime logic when generating Swagger specifications.For example, this is useful when you want to specify a model's enum for the
valuesoption and need to lazy-load the model, like this:This provides consistency, as Proc is also allowed for the
valuesoption in request parameters:https://github.com/ruby-grape/grape-swagger/blob/3e842a138b0f5edd2538d9da4aa23276e63e5d5c/lib/grape-swagger/doc_methods/parse_params.rb#L179-L180