224/mk/post quote update #230
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
This reverts commit 0309165.
wilsonianb
reviewed
Dec 9, 2022
openapi/resource-server.yaml
Outdated
| receiver: | ||
| $ref: ./schemas.yaml#/components/schemas/receiver | ||
| receiveAmount: | ||
| description: All amounts are maxima, i.e. multiple payments can be created under a grant as long as the total amounts of these payments do not exceed the maximum amount per interval as specified in the grant. |
There was a problem hiding this comment.
This description doesn't seem applicable to quotes
Suggested change
| description: All amounts are maxima, i.e. multiple payments can be created under a grant as long as the total amounts of these payments do not exceed the maximum amount per interval as specified in the grant. |
There was a problem hiding this comment.
Should we also change the description of schemas.yaml -> components -> schemas -> amount?
There was a problem hiding this comment.
Yeah, maybe we relocate that description to
open-payments/openapi/schemas.yaml
Lines 158 to 161 in 54f4bdc
There was a problem hiding this comment.
There was a problem hiding this comment.
Thanks for creating the issue!
openapi/resource-server.yaml
Outdated
| receiver: | ||
| $ref: ./schemas.yaml#/components/schemas/receiver | ||
| sendAmount: | ||
| description: All amounts are maxima, i.e. multiple payments can be created under a grant as long as the total amounts of these payments do not exceed the maximum amount per interval as specified in the grant. |
There was a problem hiding this comment.
Suggested change
| description: All amounts are maxima, i.e. multiple payments can be created under a grant as long as the total amounts of these payments do not exceed the maximum amount per interval as specified in the grant. |
wilsonianb
reviewed
Dec 9, 2022
openapi/resource-server.yaml
Outdated
| receiver: | ||
| $ref: ./schemas.yaml#/components/schemas/receiver | ||
| receiveAmount: | ||
| description: The maximum amount that should be paid into the receiving payment pointer. |
There was a problem hiding this comment.
Suggested change
| description: The maximum amount that should be paid into the receiving payment pointer. | |
| description: The fixed amount that would be paid into the receiving payment pointer. |
with maybe some caveat about assuming a successful subsequent outgoing payment.
openapi/resource-server.yaml
Outdated
| receiver: | ||
| $ref: ./schemas.yaml#/components/schemas/receiver | ||
| sendAmount: | ||
| description: The maximum amount that should be sent from the sending payment pointer. |
There was a problem hiding this comment.
Suggested change
| description: The maximum amount that should be sent from the sending payment pointer. | |
| description: The fixed amount that would be sent from the sending payment pointer. |
wilsonianb
approved these changes
Dec 9, 2022
4 tasks
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.
Changes proposed in this pull request
During quote creation, we should either expect
a) just the
receiverb)
receiver&receiveAmountc)
receiver&sendAmountI wanted to enforce this at the API level, as currently,
receiveris a required property, butreceiveAmountandsendAmountare just optional properties.After some fiddling around, I found the best way to enforce this was providing 3 possible
oneOfschemas for the quote creation request body.https://open-payments-integration.readme.io/reference/create-quote
Context
Fixes #224