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,5 +1,8 @@
title: Store
description: Holds settings for the Store, such as name, currencies, etc.
description: >-
A store holds the main settings of the commerce shop. By default, only one
store is created and used within the Medusa backend. It holds settings related
to the name of the store, available currencies, and more.
type: object
required:
- created_at
@@ -29,14 +32,14 @@ properties:
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
description: See a list of codes.
default_currency:
description: Available if the relation `default_currency` is expanded.
description: The details of the store's default currency.
x-expandable: default_currency
nullable: true
$ref: ./Currency.yaml
currencies:
description: >-
The currencies that are enabled for the Store. Available if the relation
`currencies` is expanded.
description: The details of the enabled currencies in the store.
type: array
x-expandable: currencies
items:
$ref: ./Currency.yaml
swap_link_template:
@@ -64,14 +67,13 @@ properties:
type: string
example: null
default_sales_channel_id:
description: The sales channel ID the cart is associated with.
description: The ID of the store's default sales channel.
nullable: true
type: string
example: null
default_sales_channel:
description: >-
A sales channel object. Available if the relation `default_sales_channel`
is expanded.
description: The details of the store's default sales channel.
x-expandable: default_sales_channel
nullable: true
$ref: ./SalesChannel.yaml
created_at:
@@ -88,3 +90,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