fix(core): Deprecation of lines, shipping and adjustment fields in the RefundOrderInput input.
#3119
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
+ Added documentation to the new refund amount value
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
sonntag-philipp
commented
Oct 8, 2024
| @@ -410,28 +408,28 @@ type ManualPaymentStateError implements ErrorResult { | |||
|
|
|||
| union TransitionOrderToStateResult = Order | OrderStateTransitionError | |||
| union SettlePaymentResult = | |||
There was a problem hiding this comment.
Automatic formatting. Will revert this if necessary.
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.
Description
During the refund implementation in my PayPal integration, I noticed that the
RefundOrderInputcan be a little bit confusing for new developers. At first I did not understand how I am able to use the amount instead of the lines, adjustment and shipping properties.There was no documentation for this specific input, so I reached out to the discord. In my help thread we came to false conclusions, as we thought it is not possible to just use the
amountfield by itself withoutlinesetc.After some further investigation, I noticed that deprecating the
lines,shippingandadjustmentfields in the GraphQL schema have no effects on the e2e tests. On this base, I removed those 3 fields and created this PR to make the input less confusing.I understand that my changes can be a little bit controversial, especially as now no value is required in this input. Sadly I am not experienced enough with GraphQL to say if this is okay if checks still ensure at least one option is set. I understand that the fields may better be changed back.
Breaking changes
lines,shippingandadjustmentfields in theRefundOrderInputinput.Screenshots
You can add screenshots here if applicable.
Checklist
📌 Always:
👍 Most of the time: