Validate keys given to operation/2 macro #675
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
zorbash
reviewed
Jul 30, 2025
| def operation_spec(_module, _action, false = _spec), do: nil | ||
|
|
||
| def operation_spec(module, action, spec) do | ||
| allowed_keys = [ |
Contributor
There was a problem hiding this comment.
[suggestion] Assign the allowed keys to a module attribute and list them in the @doc.
@operation_permitted_keys [:a, :b, :c]
@doc """
Define an Operation for a controller action.
See `OpenApiSpex.ControllerSpecs` for usage and examples.
Permitted operation keys:
#{for k <- @operation_permitted_keys, do: "* #{k}\n"}
"""
Contributor
Author
There was a problem hiding this comment.
Good idea! I've changed it like so (and also added a note about extension keys) and forced pushed.
zorbash
approved these changes
Jul 30, 2025
xxdavid
force-pushed
the
validate_operation_keys
branch
from
cd50619 to
472fda2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
I think it might be useful to check whether all the keys given to
OpenApiSpex.ControllerSpecs.operation/2are valid (and there is not a typo in them), similarly to what struct construction does. What do you think?