docs: enhance how references are generated (#5805)
* adjusted configurations * enhancements to tool and configurations * change reference in docs * fixed issue in workflows reference * added project name * more optimizations * fix context error * added a types reference * resolved missing types * fix reference reflection types not having children * add an expand url parameter * added new option to the README * added details about new option
This commit is contained in:
@@ -0,0 +1,21 @@
|
||||
---
|
||||
displayed_sidebar: pricingReference
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PricingContext
|
||||
|
||||
The context to calculate prices. For example, you can specify the currency code to calculate prices in.
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "context",
|
||||
"type": "`Record<string, string \\| number>`",
|
||||
"description": "an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
Reference in New Issue
Block a user