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
@@ -16,7 +16,11 @@ properties:
type: string
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
type:
description: The type of the Condition
description: >-
The type of the condition. The type affects the available resources
associated with the condition. For example, if the type is `products`,
that means the `products` relation will hold the products associated with
this condition and other relations will be empty.
type: string
enum:
- products
@@ -25,7 +29,10 @@ properties:
- product_tags
- customer_groups
operator:
description: The operator of the Condition
description: >-
The operator of the condition. `in` indicates that discountable resources
are within the specified resources. `not_in` indicates that discountable
resources are everything but the specified resources.
type: string
enum:
- in
@@ -35,43 +42,42 @@ properties:
type: string
example: dru_01F0YESMVK96HVX7N419E3CJ7C
discount_rule:
description: Available if the relation `discount_rule` is expanded.
description: The details of the discount rule associated with the condition.
x-expandable: discount_rule
nullable: true
$ref: ./DiscountRule.yaml
products:
description: >-
products associated with this condition if type = products. Available if
the relation `products` is expanded.
description: products associated with this condition if `type` is `products`.
type: array
x-expandable: products
items:
$ref: ./Product.yaml
product_types:
description: >-
Product types associated with this condition if type = product_types.
Available if the relation `product_types` is expanded.
description: Product types associated with this condition if `type` is `product_types`.
type: array
x-expandable: product_types
items:
$ref: ./ProductType.yaml
product_tags:
description: >-
Product tags associated with this condition if type = product_tags.
Available if the relation `product_tags` is expanded.
description: Product tags associated with this condition if `type` is `product_tags`.
type: array
x-expandable: product_tags
items:
$ref: ./ProductTag.yaml
product_collections:
description: >-
Product collections associated with this condition if type =
product_collections. Available if the relation `product_collections` is
expanded.
Product collections associated with this condition if `type` is
`product_collections`.
type: array
x-expandable: product_collections
items:
$ref: ./ProductCollection.yaml
customer_groups:
description: >-
Customer groups associated with this condition if type = customer_groups.
Available if the relation `customer_groups` is expanded.
Customer groups associated with this condition if `type` is
`customer_groups`.
type: array
x-expandable: customer_groups
items:
$ref: ./CustomerGroup.yaml
created_at:
@@ -93,3 +99,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