bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
14 lines
1.6 KiB
Plaintext
14 lines
1.6 KiB
Plaintext
---
|
|
displayed_sidebar: homepage
|
|
---
|
|
|
|
import TypeList from "@site/src/components/TypeList"
|
|
|
|
# AdminPostPaymentRefundsReq
|
|
|
|
The details of the refund to create.
|
|
|
|
## Properties
|
|
|
|
<TypeList types={[{"name":"amount","type":"`number`","description":"The amount to refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[RefundReason](../../entities/enums/entities.RefundReason.mdx)","description":"The reason for the Refund.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"DISCOUNT","type":"`\"discount\"`","description":"The refund is applied as a discount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"RETURN","type":"`\"return\"`","description":"The refund is applied because of a created return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"SWAP","type":"`\"swap\"`","description":"The refund is applied because of a created swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CLAIM","type":"`\"claim\"`","description":"The refund is applied because of a created claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"The refund is created for a custom reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"note","type":"`string`","description":"A note with additional details about the Refund.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="AdminPostPaymentRefundsReq"/>
|