docs: fix broken links in OAS (#14000)

This commit is contained in:
Shahed Nasser
2025-11-07 10:48:37 +02:00
committed by GitHub
parent 5a96bb7da4
commit 6cd40c9f74
169 changed files with 291 additions and 300 deletions
@@ -62,7 +62,7 @@
* type: array
* description: The claim's transactions.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
* url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
* description: Learn more about transactions of orders and associated models.
* items:
* $ref: "#/components/schemas/BaseOrderTransaction"
@@ -27,7 +27,7 @@
* type: object
* description: The flat-rate shipping option's data, useful for the fulfillment provider handling its processing.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* price_type:
* type: string
* description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider.
@@ -43,7 +43,7 @@
* type: object
* description: Any data useful for the fulfillment provider to handle the fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* description: Learn more about the data property.
* packed_at:
* type: string
@@ -40,7 +40,7 @@
* title: is_combinable
* description: Whether the tax rate should be combined with parent rates.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* metadata:
* type: object
* description: The tax rate's metadata, used to store custom key-value pairs.
@@ -48,7 +48,7 @@
* type: boolean
* description: Whether the tax rate should be combined with parent rates.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* metadata:
* type: object
* description: The default tax rate's metadata, used to store custom key-value pairs.
@@ -341,7 +341,7 @@
* type: object
* description: The data relevant for the fulfillment provider to process this shipment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
@@ -58,7 +58,7 @@
* type: array
* description: The exchange's transactions.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
* url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
* items:
* $ref: "#/components/schemas/BaseOrderTransaction"
* metadata:
@@ -72,7 +72,7 @@
* type: object
* description: The fulfillment's data, useful for the third-party provider handling the fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* metadata:
* type: object
* description: The fulfillment's metadata, can hold custom key-value pairs.
@@ -50,7 +50,7 @@
* type: object
* description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* provider_id:
* type: string
* title: provider_id
@@ -341,7 +341,7 @@
* type: object
* description: The data relevant for the fulfillment provider to process this shipment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
@@ -55,7 +55,7 @@
* type: object
* description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
@@ -33,7 +33,7 @@
* type: object
* description: The payment's data, useful for processing by the payment provider.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment
* url: https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
* created_at:
* type: string
* format: date-time
@@ -25,7 +25,7 @@
* type: object
* description: The payment session's data, useful for the payment provider processing the payment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
* context:
* type: object
* description: The context around the payment, such as the customer's details.
@@ -76,7 +76,7 @@
* type: object
* description: The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* metadata:
* type: object
* description: The shipping option's metadata, can hold custom key-value pairs.
@@ -51,7 +51,7 @@
* title: is_combinable
* description: Whether the tax rate should be combined with parent rates.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* is_default:
* type: boolean
* title: is_default
@@ -30,7 +30,7 @@
* title: is_combinable
* description: Whether the tax rate should be combined with parent rates.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* metadata:
* type: object
* description: The tax rate's metadata, can hold custom key-value pairs.
@@ -50,7 +50,7 @@
* type: object
* description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* provider_id:
* type: string
* title: provider_id
@@ -55,7 +55,7 @@
* type: object
* description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
@@ -33,7 +33,7 @@
* type: object
* description: The payment's data, useful for processing by the payment provider.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment
* url: https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
* created_at:
* type: string
* format: date-time
@@ -58,7 +58,7 @@
* type: array
* description: The claim's transactions.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
* url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
* description: Learn more about transactions of orders and associated models.
* items:
* $ref: "#/components/schemas/OrderTransaction"
@@ -51,7 +51,7 @@
* type: array
* description: The exchange's transactions.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
* url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
* items:
* $ref: "#/components/schemas/OrderTransaction"
* metadata:
@@ -52,7 +52,7 @@
* type: object
* description: The shipping method's data, useful for the fulfillment provider handling the fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
@@ -44,7 +44,7 @@
* type: object
* description: The shipping method's data, useful for fulfillment handling by third-party services.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/cart/concepts#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
@@ -93,7 +93,7 @@
* type: object
* description: The shipping option's data, useful for the provider handling fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* prices:
* type: array
* description: The shipping option's prices.
@@ -14,7 +14,7 @@
* type: object
* description: Any data necessary for the payment provider to process the payment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
* description: Learn more about the payment session's data property
* x-schemaName: StoreInitializePaymentSession
*
@@ -50,7 +50,7 @@
* type: object
* description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* provider_id:
* type: string
* title: provider_id
@@ -55,7 +55,7 @@
* type: object
* description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
@@ -25,7 +25,7 @@
* type: object
* description: The payment session's data, useful for the payment provider processing the payment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
* context:
* type: object
* description: The context around the payment, such as the customer's details.
@@ -101,14 +101,14 @@
* title: manage_inventory
* description: Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory
* url: https://docs.medusajs.com/resources/storefront-development/products/inventory
* description: "Storefront guide: How to retrieve a product variant's inventory details."
* inventory_quantity:
* type: number
* title: inventory_quantity
* description: The variant's inventory quantity. This property is only available if you pass `+variants.inventory_quantity` in the `fields` query parameter.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory
* url: https://docs.medusajs.com/resources/storefront-development/products/inventory
* description: "Storefront guide: How to retrieve a product variant's inventory details."
* variant_rank:
* type: number
@@ -65,7 +65,7 @@
* type: object
* description: The shipping option's data, useful for the provider handling fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* metadata:
* type: object
* description: The shipping option's metadata, can hold custom key-value pairs.