From 7963c16233aedf2cd838c60e8e6275e5b00c6769 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 9 May 2023 18:12:00 +0300 Subject: [PATCH] chore(docs): Generated API Reference (#4054) Co-authored-by: olivermrbl Co-authored-by: Shahed Nasser --- docs/api/admin.oas.json | 44 ++++++++++++++----- docs/api/admin/components/schemas/Cart.yaml | 3 +- .../admin/components/schemas/ClaimOrder.yaml | 3 +- .../admin/components/schemas/DraftOrder.yaml | 3 +- .../admin/components/schemas/Fulfillment.yaml | 3 +- .../components/schemas/IdempotencyKey.yaml | 3 +- .../components/schemas/InventoryItemDTO.yaml | 9 ++++ docs/api/admin/components/schemas/Order.yaml | 3 +- .../api/admin/components/schemas/Payment.yaml | 3 +- .../components/schemas/PaymentSession.yaml | 3 +- docs/api/admin/components/schemas/Refund.yaml | 3 +- .../schemas/ReservationItemDTO.yaml | 6 +++ docs/api/admin/components/schemas/Return.yaml | 3 +- docs/api/admin/components/schemas/Swap.yaml | 3 +- .../components/schemas/TrackingLink.yaml | 3 +- docs/api/store.oas.json | 44 ++++++++++++++----- docs/api/store/components/schemas/Cart.yaml | 3 +- .../store/components/schemas/ClaimOrder.yaml | 3 +- .../store/components/schemas/DraftOrder.yaml | 3 +- .../store/components/schemas/Fulfillment.yaml | 3 +- .../components/schemas/IdempotencyKey.yaml | 3 +- .../components/schemas/InventoryItemDTO.yaml | 9 ++++ docs/api/store/components/schemas/Order.yaml | 3 +- .../api/store/components/schemas/Payment.yaml | 3 +- .../components/schemas/PaymentSession.yaml | 3 +- docs/api/store/components/schemas/Refund.yaml | 3 +- .../schemas/ReservationItemDTO.yaml | 6 +++ docs/api/store/components/schemas/Return.yaml | 3 +- docs/api/store/components/schemas/Swap.yaml | 3 +- .../components/schemas/TrackingLink.yaml | 3 +- 30 files changed, 118 insertions(+), 72 deletions(-) diff --git a/docs/api/admin.oas.json b/docs/api/admin.oas.json index b489feb120..351603077c 100644 --- a/docs/api/admin.oas.json +++ b/docs/api/admin.oas.json @@ -32392,7 +32392,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -32835,7 +32835,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } } @@ -33945,7 +33945,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -34163,7 +34163,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -34438,7 +34438,7 @@ "description": "The unique randomly generated key used to determine the state of a process.", "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -34565,6 +34565,18 @@ "description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "type": "string" }, + "title": { + "description": "Title of the inventory item", + "type": "string" + }, + "description": { + "description": "Description of the inventory item", + "type": "string" + }, + "thumbnail": { + "description": "Thumbnail for the inventory item", + "type": "string" + }, "material": { "description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "type": "string" @@ -35784,7 +35796,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -36263,7 +36275,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -36507,7 +36519,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -37884,7 +37896,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -38065,6 +38077,14 @@ "description": "The id of the inventory item the reservation relates to", "type": "string" }, + "description": { + "description": "Description of the reservation item", + "type": "string" + }, + "created_by": { + "description": "UserId of user who created the reservation item", + "type": "string" + }, "quantity": { "description": "The id of the reservation item", "type": "number" @@ -38221,7 +38241,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -39519,7 +39539,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -39775,7 +39795,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, diff --git a/docs/api/admin/components/schemas/Cart.yaml b/docs/api/admin/components/schemas/Cart.yaml index db025e4ca0..42935b558b 100644 --- a/docs/api/admin/components/schemas/Cart.yaml +++ b/docs/api/admin/components/schemas/Cart.yaml @@ -129,8 +129,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/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. diff --git a/docs/api/admin/components/schemas/ClaimOrder.yaml b/docs/api/admin/components/schemas/ClaimOrder.yaml index 3c25d434af..5c439738c7 100644 --- a/docs/api/admin/components/schemas/ClaimOrder.yaml +++ b/docs/api/admin/components/schemas/ClaimOrder.yaml @@ -140,6 +140,5 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. diff --git a/docs/api/admin/components/schemas/DraftOrder.yaml b/docs/api/admin/components/schemas/DraftOrder.yaml index e286c08494..39e150901f 100644 --- a/docs/api/admin/components/schemas/DraftOrder.yaml +++ b/docs/api/admin/components/schemas/DraftOrder.yaml @@ -70,8 +70,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/admin/components/schemas/Fulfillment.yaml b/docs/api/admin/components/schemas/Fulfillment.yaml index 93ed0dba7f..8de3d7072b 100644 --- a/docs/api/admin/components/schemas/Fulfillment.yaml +++ b/docs/api/admin/components/schemas/Fulfillment.yaml @@ -125,8 +125,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/admin/components/schemas/IdempotencyKey.yaml b/docs/api/admin/components/schemas/IdempotencyKey.yaml index e2f83b4b8a..9a8760eec9 100644 --- a/docs/api/admin/components/schemas/IdempotencyKey.yaml +++ b/docs/api/admin/components/schemas/IdempotencyKey.yaml @@ -25,8 +25,7 @@ properties: process. type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: Date which the idempotency key was locked. diff --git a/docs/api/admin/components/schemas/InventoryItemDTO.yaml b/docs/api/admin/components/schemas/InventoryItemDTO.yaml index 5053d91286..9fccc01512 100644 --- a/docs/api/admin/components/schemas/InventoryItemDTO.yaml +++ b/docs/api/admin/components/schemas/InventoryItemDTO.yaml @@ -21,6 +21,15 @@ properties: the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string + title: + description: Title of the inventory item + type: string + description: + description: Description of the inventory item + type: string + thumbnail: + description: Thumbnail for the inventory item + type: string material: description: >- The material and composition that the Inventory Item is made of, May be diff --git a/docs/api/admin/components/schemas/Order.yaml b/docs/api/admin/components/schemas/Order.yaml index 42959c12a8..1051ad1ea6 100644 --- a/docs/api/admin/components/schemas/Order.yaml +++ b/docs/api/admin/components/schemas/Order.yaml @@ -244,8 +244,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. external_id: description: The ID of an external order. diff --git a/docs/api/admin/components/schemas/Payment.yaml b/docs/api/admin/components/schemas/Payment.yaml index 19676483f2..6f9d0d69a2 100644 --- a/docs/api/admin/components/schemas/Payment.yaml +++ b/docs/api/admin/components/schemas/Payment.yaml @@ -101,8 +101,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/admin/components/schemas/PaymentSession.yaml b/docs/api/admin/components/schemas/PaymentSession.yaml index f11f972388..f49ce46db4 100644 --- a/docs/api/admin/components/schemas/PaymentSession.yaml +++ b/docs/api/admin/components/schemas/PaymentSession.yaml @@ -81,8 +81,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. amount: description: The amount that the Payment Session has been authorized for. diff --git a/docs/api/admin/components/schemas/Refund.yaml b/docs/api/admin/components/schemas/Refund.yaml index 9b6074396d..48ab1bfe12 100644 --- a/docs/api/admin/components/schemas/Refund.yaml +++ b/docs/api/admin/components/schemas/Refund.yaml @@ -66,8 +66,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/admin/components/schemas/ReservationItemDTO.yaml b/docs/api/admin/components/schemas/ReservationItemDTO.yaml index 2a99d8583f..5e4f31bfec 100644 --- a/docs/api/admin/components/schemas/ReservationItemDTO.yaml +++ b/docs/api/admin/components/schemas/ReservationItemDTO.yaml @@ -16,6 +16,12 @@ properties: inventory_item_id: description: The id of the inventory item the reservation relates to type: string + description: + description: Description of the reservation item + type: string + created_by: + description: UserId of user who created the reservation item + type: string quantity: description: The id of the reservation item type: number diff --git a/docs/api/admin/components/schemas/Return.yaml b/docs/api/admin/components/schemas/Return.yaml index e28eb3122d..b2b07fc9bf 100644 --- a/docs/api/admin/components/schemas/Return.yaml +++ b/docs/api/admin/components/schemas/Return.yaml @@ -102,8 +102,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. received_at: description: The date with timezone at which the return was received. diff --git a/docs/api/admin/components/schemas/Swap.yaml b/docs/api/admin/components/schemas/Swap.yaml index fe360735f2..2a0d1938a3 100644 --- a/docs/api/admin/components/schemas/Swap.yaml +++ b/docs/api/admin/components/schemas/Swap.yaml @@ -153,8 +153,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/admin/components/schemas/TrackingLink.yaml b/docs/api/admin/components/schemas/TrackingLink.yaml index 53ba3580ce..1d73c9c7e5 100644 --- a/docs/api/admin/components/schemas/TrackingLink.yaml +++ b/docs/api/admin/components/schemas/TrackingLink.yaml @@ -43,8 +43,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/store.oas.json b/docs/api/store.oas.json index fc125a7070..ec1f53dee2 100644 --- a/docs/api/store.oas.json +++ b/docs/api/store.oas.json @@ -6489,7 +6489,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -6932,7 +6932,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } } @@ -8042,7 +8042,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -8260,7 +8260,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -8535,7 +8535,7 @@ "description": "The unique randomly generated key used to determine the state of a process.", "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -8662,6 +8662,18 @@ "description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "type": "string" }, + "title": { + "description": "Title of the inventory item", + "type": "string" + }, + "description": { + "description": "Description of the inventory item", + "type": "string" + }, + "thumbnail": { + "description": "Thumbnail for the inventory item", + "type": "string" + }, "material": { "description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "type": "string" @@ -9881,7 +9893,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -10360,7 +10372,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -10604,7 +10616,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -11981,7 +11993,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -12162,6 +12174,14 @@ "description": "The id of the inventory item the reservation relates to", "type": "string" }, + "description": { + "description": "Description of the reservation item", + "type": "string" + }, + "created_by": { + "description": "UserId of user who created the reservation item", + "type": "string" + }, "quantity": { "description": "The id of the reservation item", "type": "number" @@ -12300,7 +12320,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -15176,7 +15196,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, @@ -15432,7 +15452,7 @@ "nullable": true, "type": "string", "externalDocs": { - "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key", + "url": "https://docs.medusajs.com/development/idempotency-key/overview.md", "description": "Learn more how to use the idempotency key." } }, diff --git a/docs/api/store/components/schemas/Cart.yaml b/docs/api/store/components/schemas/Cart.yaml index db025e4ca0..42935b558b 100644 --- a/docs/api/store/components/schemas/Cart.yaml +++ b/docs/api/store/components/schemas/Cart.yaml @@ -129,8 +129,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/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. diff --git a/docs/api/store/components/schemas/ClaimOrder.yaml b/docs/api/store/components/schemas/ClaimOrder.yaml index 3c25d434af..5c439738c7 100644 --- a/docs/api/store/components/schemas/ClaimOrder.yaml +++ b/docs/api/store/components/schemas/ClaimOrder.yaml @@ -140,6 +140,5 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. diff --git a/docs/api/store/components/schemas/DraftOrder.yaml b/docs/api/store/components/schemas/DraftOrder.yaml index e286c08494..39e150901f 100644 --- a/docs/api/store/components/schemas/DraftOrder.yaml +++ b/docs/api/store/components/schemas/DraftOrder.yaml @@ -70,8 +70,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/store/components/schemas/Fulfillment.yaml b/docs/api/store/components/schemas/Fulfillment.yaml index 93ed0dba7f..8de3d7072b 100644 --- a/docs/api/store/components/schemas/Fulfillment.yaml +++ b/docs/api/store/components/schemas/Fulfillment.yaml @@ -125,8 +125,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/store/components/schemas/IdempotencyKey.yaml b/docs/api/store/components/schemas/IdempotencyKey.yaml index e2f83b4b8a..9a8760eec9 100644 --- a/docs/api/store/components/schemas/IdempotencyKey.yaml +++ b/docs/api/store/components/schemas/IdempotencyKey.yaml @@ -25,8 +25,7 @@ properties: process. type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: Date which the idempotency key was locked. diff --git a/docs/api/store/components/schemas/InventoryItemDTO.yaml b/docs/api/store/components/schemas/InventoryItemDTO.yaml index 5053d91286..9fccc01512 100644 --- a/docs/api/store/components/schemas/InventoryItemDTO.yaml +++ b/docs/api/store/components/schemas/InventoryItemDTO.yaml @@ -21,6 +21,15 @@ properties: the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string + title: + description: Title of the inventory item + type: string + description: + description: Description of the inventory item + type: string + thumbnail: + description: Thumbnail for the inventory item + type: string material: description: >- The material and composition that the Inventory Item is made of, May be diff --git a/docs/api/store/components/schemas/Order.yaml b/docs/api/store/components/schemas/Order.yaml index 42959c12a8..1051ad1ea6 100644 --- a/docs/api/store/components/schemas/Order.yaml +++ b/docs/api/store/components/schemas/Order.yaml @@ -244,8 +244,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. external_id: description: The ID of an external order. diff --git a/docs/api/store/components/schemas/Payment.yaml b/docs/api/store/components/schemas/Payment.yaml index 19676483f2..6f9d0d69a2 100644 --- a/docs/api/store/components/schemas/Payment.yaml +++ b/docs/api/store/components/schemas/Payment.yaml @@ -101,8 +101,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/store/components/schemas/PaymentSession.yaml b/docs/api/store/components/schemas/PaymentSession.yaml index f11f972388..f49ce46db4 100644 --- a/docs/api/store/components/schemas/PaymentSession.yaml +++ b/docs/api/store/components/schemas/PaymentSession.yaml @@ -81,8 +81,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. amount: description: The amount that the Payment Session has been authorized for. diff --git a/docs/api/store/components/schemas/Refund.yaml b/docs/api/store/components/schemas/Refund.yaml index 9b6074396d..48ab1bfe12 100644 --- a/docs/api/store/components/schemas/Refund.yaml +++ b/docs/api/store/components/schemas/Refund.yaml @@ -66,8 +66,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/store/components/schemas/ReservationItemDTO.yaml b/docs/api/store/components/schemas/ReservationItemDTO.yaml index 2a99d8583f..5e4f31bfec 100644 --- a/docs/api/store/components/schemas/ReservationItemDTO.yaml +++ b/docs/api/store/components/schemas/ReservationItemDTO.yaml @@ -16,6 +16,12 @@ properties: inventory_item_id: description: The id of the inventory item the reservation relates to type: string + description: + description: Description of the reservation item + type: string + created_by: + description: UserId of user who created the reservation item + type: string quantity: description: The id of the reservation item type: number diff --git a/docs/api/store/components/schemas/Return.yaml b/docs/api/store/components/schemas/Return.yaml index e28eb3122d..b2b07fc9bf 100644 --- a/docs/api/store/components/schemas/Return.yaml +++ b/docs/api/store/components/schemas/Return.yaml @@ -102,8 +102,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. received_at: description: The date with timezone at which the return was received. diff --git a/docs/api/store/components/schemas/Swap.yaml b/docs/api/store/components/schemas/Swap.yaml index fe360735f2..2a0d1938a3 100644 --- a/docs/api/store/components/schemas/Swap.yaml +++ b/docs/api/store/components/schemas/Swap.yaml @@ -153,8 +153,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created. diff --git a/docs/api/store/components/schemas/TrackingLink.yaml b/docs/api/store/components/schemas/TrackingLink.yaml index 53ba3580ce..1d73c9c7e5 100644 --- a/docs/api/store/components/schemas/TrackingLink.yaml +++ b/docs/api/store/components/schemas/TrackingLink.yaml @@ -43,8 +43,7 @@ properties: nullable: true type: string externalDocs: - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key + url: https://docs.medusajs.com/development/idempotency-key/overview.md description: Learn more how to use the idempotency key. created_at: description: The date with timezone at which the resource was created.