[NCE-917] Update docs for prepaid cards#26
Conversation
angel-obretenov-runa
force-pushed
the
nce-917
branch
from
98c82f2 to
bfcc2ad
Compare
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
angel-obretenov-runa
force-pushed
the
nce-917
branch
from
bfcc2ad to
c8761d4
Compare
| @@ -0,0 +1,54 @@ | |||
| --- | |||
There was a problem hiding this comment.
This page leaves an open question of where these template IDs come from. Have we got that yet?
There was a problem hiding this comment.
I've left at the bottom of the page some info on how to get that
| "oneOf": [ | ||
| { | ||
| "$ref": "#/components/schemas/SingleProduct" | ||
| "$ref": "#/components/schemas/SingleProductWithUsageConfig" |
There was a problem hiding this comment.
Why rename the component rather than extending the existing one?
Ideally we apply this to all cases, other services such as the estimate endpoint can ignore the extra fields for now.
There was a problem hiding this comment.
my idea was to not include this parameter in the estimate endpoints. It is optional, but it serves no purpose for the estimate endpoint
| "example": "AMZ-US", | ||
| "type": "string" | ||
| }, | ||
| "product_usage_config": { |
There was a problem hiding this comment.
Is it too late to suggest dropping product_ from this key?
| "product_usage_config": { | |
| "usage_config": { |
We're already inside the products object so products.usage_config is sufficent, products.product_usage_config repeats.
There was a problem hiding this comment.
one potential side effect of that would be if in the future we decide the store the whole field for other services, then we should store it as product_usage_config so they know it's related to the product.
The change will be only in ROS and we have to change the contract a bit
It's not a big change, I'll draft a ticket
3 participants
Adds public-docs coverage for the new optional
product_usage_config.spend_rules_template_idfield, which attaches a Runa-authored MCC-rules template to an issued prepaid Visa card.Changes
OpenAPI: added
ProductUsageConfigand a dedicatedSingleProductWithUsageConfigschema, wired into the create order request and get order details response only. SharedSingleProductleft untouched. Descriptions note it's prepaid-Visa-only and echoed back when set.Guide: Added a new page called 'Card spend controls' where it's explained everything MCC related
product usage config mentioned in the request body field for Create order
mentioned in Using Prepaid Visa Cards
New page Card spend controls
