chore(must-define-example-schema): Weaken strictness of rule #37
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
…require examples for DTOs Before a example was required for every key "content" which was quiet strict as examples can also be placed at attribute level. Now the rule only enforces a top-level example for every global DTO, thereby also matching the error message. It would be possible to enforce the usage of only DTOs for request bodys and responses in the future to further improve this rule.
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.
Weaken strictness of rule to only require examples for DTOs
Before a example was required for every key "content" which was quiet strict as examples can also be placed at attribute level. Now the rule only enforces a top-level example for every global DTO, thereby also matching the error message. It would be possible to enforce the usage of only DTOs for request bodys and responses in the future to further improve this rule.