chore(docs): Updated API Reference (v2) (#9437)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-10-03 07:48:54 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 97c193be1b
commit 21badd069d
894 changed files with 35649 additions and 28168 deletions
@@ -1,21 +1,21 @@
type: object
description: SUMMARY
description: The properties to update in the tax rate.
x-schemaName: AdminUpdateTaxRate
properties:
rate:
type: number
title: rate
description: The tax rate's rate.
description: The rate to charge.
code:
type: string
title: code
description: The tax rate's code.
description: The code that the tax rate is identified by.
rules:
type: array
description: The tax rate's rules.
items:
type: object
description: The rule's rules.
description: A tax rate rule.
required:
- reference
- reference_id
@@ -23,11 +23,13 @@ properties:
reference:
type: string
title: reference
description: The rule's reference.
description: The name of the table this rule references.
example: product_type
reference_id:
type: string
title: reference_id
description: The rule's reference id.
description: The ID of the record in the table that the rule references.
example: ptyp_123
name:
type: string
title: name
@@ -35,11 +37,14 @@ properties:
is_default:
type: boolean
title: is_default
description: The tax rate's is default.
description: Whether the tax rate is the default in the store.
is_combinable:
type: boolean
title: is_combinable
description: The tax rate's is combinable.
description: Whether the tax rate should be combined with parent rates.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata:
type: object
description: The tax rate's metadata.
description: The tax rate's metadata, can hold custom key-value pairs.