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:
committed by
GitHub
parent
efdea04963
commit
658339767b
@@ -1,5 +1,5 @@
|
||||
title: Discount
|
||||
description: Represents a discount that can be applied to a cart for promotional purposes.
|
||||
description: A discount can be applied to a cart for promotional purposes.
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
@@ -35,12 +35,17 @@ properties:
|
||||
type: boolean
|
||||
example: false
|
||||
rule_id:
|
||||
description: The Discount Rule that governs the behaviour of the Discount
|
||||
description: >-
|
||||
The ID of the discount rule that defines how the discount will be applied
|
||||
to a cart.
|
||||
nullable: true
|
||||
type: string
|
||||
example: dru_01F0YESMVK96HVX7N419E3CJ7C
|
||||
rule:
|
||||
description: Available if the relation `rule` is expanded.
|
||||
description: >-
|
||||
The details of the discount rule that defines how the discount will be
|
||||
applied to a cart..
|
||||
x-expandable: rule
|
||||
nullable: true
|
||||
$ref: ./DiscountRule.yaml
|
||||
is_disabled:
|
||||
@@ -57,7 +62,8 @@ properties:
|
||||
type: string
|
||||
example: disc_01G8ZH853YPY9B94857DY91YGW
|
||||
parent_discount:
|
||||
description: Available if the relation `parent_discount` is expanded.
|
||||
description: The details of the parent discount that this discount was created from.
|
||||
x-expandable: parent_discount
|
||||
nullable: true
|
||||
type: object
|
||||
starts_at:
|
||||
@@ -75,10 +81,9 @@ properties:
|
||||
type: string
|
||||
example: P3Y6M4DT12H30M5S
|
||||
regions:
|
||||
description: >-
|
||||
The Regions in which the Discount can be used. Available if the relation
|
||||
`regions` is expanded.
|
||||
description: The details of the regions in which the Discount can be used.
|
||||
type: array
|
||||
x-expandable: regions
|
||||
items:
|
||||
$ref: ./Region.yaml
|
||||
usage_limit:
|
||||
@@ -110,3 +115,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
|
||||
|
||||
Reference in New Issue
Block a user