chore(docs): Generated API Reference (#4706)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions

View File

@@ -1,7 +1,7 @@
title: Tax Rate
description: >-
A Tax Rate can be used to associate a certain rate to charge on products
within a given Region
A Tax Rate can be used to define a custom rate to charge on specified
products, product types, and shipping options within a given region.
type: object
required:
- code
@@ -32,32 +32,30 @@ properties:
type: string
example: Tax Example
region_id:
description: The id of the Region that the rate belongs to
description: The ID of the region that the rate belongs to.
type: string
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
region:
description: A region object. Available if the relation `region` is expanded.
description: The details of the region that the rate belongs to.
x-expandable: region
nullable: true
type: object
products:
description: >-
The products that belong to this tax rate. Available if the relation
`products` is expanded.
description: The details of the products that belong to this tax rate.
type: array
x-expandable: products
items:
$ref: ./Product.yaml
product_types:
description: >-
The product types that belong to this tax rate. Available if the relation
`product_types` is expanded.
description: The details of the product types that belong to this tax rate.
type: array
x-expandable: product_types
items:
$ref: ./ProductType.yaml
shipping_options:
description: The details of the shipping options that belong to this tax rate.
type: array
description: >-
The shipping options that belong to this tax rate. Available if the
relation `shipping_options` is expanded.
x-expandable: shipping_options
items:
$ref: ./ShippingOption.yaml
product_count:
@@ -86,3 +84,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute