Add clarifying notes around using round number for TEMPLATE (and MULT…#16
Merged
Add clarifying notes around using round number for TEMPLATE (and MULT…#16
Conversation
…IPLE) product orders
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds clarifying documentation about face value requirements for TEMPLATE and MULTIPLE product order modes, specifically noting that round numbers must be used in these scenarios.
- Updates the OpenAPI specification to detail face value constraints based on product mode (SINGLE, MULTIPLE, TEMPLATE)
- Adds instructional guidance in the merchant selection template documentation about face value requirements
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| reference/2024-02-05/openapi.json | Expands the face_value field description to clarify that MULTIPLE and TEMPLATE modes require round numbers that meet minimum face value requirements |
| features/merchant-selection-template.mdx | Adds a new step instructing users to ensure face_value is a round number meeting minimum requirements when using templates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
reference/2024-02-05/openapi.json
Outdated
| "face_value": { | ||
| "title": "Face Value", | ||
| "description": "Face value of the payout link. The currency of the face value is inferred from the product selection.", | ||
| "description": "Face value of the payout link. The currency of the face value is inferred from the product selection.\n\nWhat value is allowed depends on the product mode:\n- When ordering a `SINGLE` product this field follows the allowed values from the selected product.\n- If using `MULTIPLE` or `TEMPLATE` this value must be: equal or greater than the minimum face value of the products selected and be a round number.", |
There was a problem hiding this comment.
[nitpick] Consider restructuring the sentence for better readability. The colon followed by "equal or greater than" is awkward. Suggestion: "If using MULTIPLE or TEMPLATE, this value must be equal to or greater than the minimum face value of the products selected and must be a round number."
Suggested change
| "description": "Face value of the payout link. The currency of the face value is inferred from the product selection.\n\nWhat value is allowed depends on the product mode:\n- When ordering a `SINGLE` product this field follows the allowed values from the selected product.\n- If using `MULTIPLE` or `TEMPLATE` this value must be: equal or greater than the minimum face value of the products selected and be a round number.", | |
| "description": "Face value of the payout link. The currency of the face value is inferred from the product selection.\n\nWhat value is allowed depends on the product mode:\n- When ordering a `SINGLE` product this field follows the allowed values from the selected product.\n- If using `MULTIPLE` or `TEMPLATE`, this value must be equal to or greater than the minimum face value of the products selected and must be a round number.", |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or 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
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.
…IPLE) product orders