Optional paths #275
Merged
Optional paths #275
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
Sets `paths` only if it is specified when decoded, and encodes it when it is not empty. Also adds simple tests (based on the existing webhooks ones) that make sure the behavior works as expected.
Some of the tests are no longer necessary due to paths being optional (so for example, the validation that makes sure there's at least one path is removed).
mattpolzin
requested changes
Jun 15, 2023
There was a problem hiding this comment.
This looks great, but let's keep the validation around. It was off-by-default anyway which means it doesn't get in anyone's way but if someone does want to ensure their API docs always have paths then the validation is available out of box (it's one that I apply currently to my workplace's API documentation).
The docs for the path validation could be updated, though, now that there's a very reasonable use case that would result in no path items.
…pdate documentation around the changes.
|
I fixed the merge conflict that was just introduced upstream and went ahead and threw the optional validation back in because that's the only request I had before moving forward with this PR. |
mattpolzin
approved these changes
Sep 4, 2023
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.
Closes #190.
Makes
pathsoptional.Also removing validation checks for having at least one path (I'm actually on the fence about it because one could want to check for them, could be brought back in the case of them being needed).