Optional request bodies #5
Merged
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
svix-onelson
force-pushed
the
onelson/optional-request-bodies
branch
from
f5c8987 to
12cbd71
Compare
tasn
reviewed
Jan 6, 2025
svix-onelson
force-pushed
the
onelson/optional-request-bodies
branch
from
12cbd71 to
4e77274
Compare
svix-onelson
force-pushed
the
onelson/optional-request-bodies
branch
2 times, most recently
from
7a36da7 to
e4fc077
Compare
svix-jplatte
approved these changes
Jan 7, 2025
svix-onelson
force-pushed
the
onelson/optional-request-bodies
branch
from
e4fc077 to
dbb8484
Compare
The idea is to identify args for the CLI that can be omitted since the entire body is technically optional.
svix-onelson
force-pushed
the
onelson/optional-request-bodies
branch
from
dbb8484 to
36fbdbe
Compare
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.
The idea is to identify args for the CLI that can be omitted since the entire body is technically optional.
A problem with the current approach is the optionalness is applied uniform to all cases which includes
PATCHrequests. Ideally, we'd be treating thePATCHbodies as required, but there's no real harm in letting these flow through as-is.Today, a user can happily pass an empty object as a body to any
PATCHrequest. This will update theupdatedAttimestamp but leave all other fields as-is.The code for this is a little clumsy. We can likely optimize a bit, remove some clones. I'll leave that for someone with the appetite. I hear there is a different approach we might take anyway. Something involving passing the full component schemas to the template.
Here's the (gently modified) output from these template updates: svix/svix-webhooks#1621