fix: only add mutually exclusive description if argument is a lookup argument set #81
Conversation
This file contains 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
Comment on lines
-83
to
+86
| @schema[:description] ||= | ||
| "All '#{@definition.name}[]' params are mutually exclusive, only one can be provided." | ||
| if @definition.type.klass.ancestors.include?(Apia::LookupArgumentSet) | ||
| @schema[:description] ||= | ||
| "All '#{@definition.name}[]' params are mutually exclusive, only one can be provided." | ||
| end |
There was a problem hiding this comment.
change looks good, but can we update the specs to ensure we don't accidentally break this in future?
There was a problem hiding this comment.
Added a post for the plain_text endpoint which uses the regular KeyValue argument set in the body. This doesn't use the mutually exclusive description.
Does that cover what you're looking for?
There was a problem hiding this comment.
Oh I also disabled the BlockLength cop in example/base.rb because refactoring that feels like it would make things less readable
paulsturgess
approved these changes
Sep 19, 2024
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.
No description provided.