Skip to content

Commit

Permalink
chore(docs): Generated API Reference (#11060)
Browse files Browse the repository at this point in the history
Co-authored-by: olivermrbl <[email protected]>
Co-authored-by: Shahed Nasser <[email protected]>
  • Loading branch information
3 people authored Jan 21, 2025
1 parent 328175f commit 84306e3
Show file tree
Hide file tree
Showing 191 changed files with 449 additions and 442 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -122,4 +122,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ properties:
Learn about the metadata attribute, and how to delete and update
it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
region_id:
description: The ID of the region for the draft order
type: string
Expand Down Expand Up @@ -107,4 +107,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
no_notification:
description: >-
If set to `true`, no notification will be sent to the customer related to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ properties:
Learn about the metadata attribute, and how to delete and update
it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
shipping_methods:
description: The Shipping Methods to send the additional Line Items with.
type: array
Expand Down Expand Up @@ -90,4 +90,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
no_notification:
description: >-
If set to `true`, no notification will be sent to the customer related to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -174,15 +174,15 @@ properties:
Learn about the metadata attribute, and how to delete and update
it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
prices:
type: array
description: >-
An array of product variant prices. A product variant can have
different prices for each region or currency code.
externalDocs:
url: >-
https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices
https://docs.medusajs.com/v1/modules/products/admin/manage-products#product-variant-prices
description: Product variant pricing.
items:
type: object
Expand Down Expand Up @@ -265,4 +265,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,15 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
prices:
type: array
description: >-
An array of product variant prices. A product variant can have different
prices for each region or currency code.
externalDocs:
url: >-
https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices
https://docs.medusajs.com/v1/modules/products/admin/manage-products#product-variant-prices
description: Product variant pricing.
items:
type: object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
prices:
type: array
description: >-
An array of product variant prices. A product variant can have different
prices for each region or currency code.
externalDocs:
url: >-
https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices
https://docs.medusajs.com/v1/modules/products/admin/manage-products#product-variant-prices
description: Product variant pricing.
items:
type: object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -196,15 +196,15 @@ properties:
Learn about the metadata attribute, and how to delete and update
it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
prices:
type: array
description: >-
An array of product variant prices. A product variant can have
different prices for each region or currency code.
externalDocs:
url: >-
https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices
https://docs.medusajs.com/v1/modules/products/admin/manage-products#product-variant-prices
description: Product variant pricing.
items:
type: object
Expand Down Expand Up @@ -245,7 +245,7 @@ properties:
as in the `options` field of the product.
externalDocs:
url: >-
https://docs.medusajs.com/modules/products/admin/manage-products#create-a-product
https://docs.medusajs.com/v1/modules/products/admin/manage-products#create-a-product
description: Example of how to create a product with options and variants
items:
type: object
Expand Down Expand Up @@ -287,4 +287,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ properties:
for carts in this region. If set to `false`, the taxes must be calculated
manually.
externalDocs:
url: https://docs.medusajs.com/modules/taxes/storefront/manual-calculation
url: https://docs.medusajs.com/v1/modules/taxes/storefront/manual-calculation
description: How to calculate taxes in a storefront.
type: boolean
gift_cards_taxable:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
requirements:
description: >-
The requirements that must be satisfied for the Shipping Option to be
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
includes_tax:
description: Tax included in prices of shipping option
x-featureFlag: tax_inclusive_pricing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
type:
description: The type of the Shipping Profile
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
address:
description: The data of an associated address to create or update.
$ref: ./StockLocationAddressInput.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
address:
description: >-
A new stock location address to create and associate with the stock
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ properties:
nullable: true
type: string
externalDocs:
url: https://docs.medusajs.com/development/idempotency-key/overview.md
url: https://docs.medusajs.com/v1/development/idempotency-key/overview.md
description: Learn more how to use the idempotency key.
context:
description: The context of the cart which can include info like IP or user agent.
Expand Down Expand Up @@ -183,7 +183,7 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
shipping_total:
description: The total of shipping
type: integer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ properties:
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
https://docs.medusajs.com/v1/development/entities/overview#metadata-attribute
Loading

0 comments on commit 84306e3

Please sign in to comment.