From 8d0ce0af06df39022f07cc618e069849ddeb0f41 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 27 Jul 2023 12:44:16 +0300 Subject: [PATCH] chore(oas): add link for additional info on metadata (#4613) --- .../generated/client-types/src/lib/models/SalesChannel.ts | 4 ++++ .../src/api/routes/admin/collections/create-collection.ts | 3 +++ .../src/api/routes/admin/collections/update-collection.ts | 3 +++ .../routes/admin/customer-groups/create-customer-group.ts | 3 +++ .../routes/admin/customer-groups/update-customer-group.ts | 3 +++ .../src/api/routes/admin/customers/create-customer.ts | 3 +++ .../src/api/routes/admin/customers/update-customer.ts | 3 +++ .../src/api/routes/admin/discounts/create-discount.ts | 3 +++ .../src/api/routes/admin/discounts/create-dynamic-code.ts | 3 +++ .../src/api/routes/admin/discounts/update-discount.ts | 3 +++ .../api/routes/admin/draft-orders/create-draft-order.ts | 6 ++++++ .../src/api/routes/admin/draft-orders/create-line-item.ts | 3 +++ .../src/api/routes/admin/draft-orders/update-line-item.ts | 3 +++ .../src/api/routes/admin/gift-cards/create-gift-card.ts | 3 +++ .../src/api/routes/admin/gift-cards/update-gift-card.ts | 3 +++ .../routes/admin/inventory-items/create-inventory-item.ts | 3 +++ .../src/api/routes/admin/order-edits/add-line-item.ts | 3 +++ .../medusa/src/api/routes/admin/orders/create-claim.ts | 3 +++ .../src/api/routes/admin/orders/create-fulfillment.ts | 3 +++ .../medusa/src/api/routes/admin/orders/fulfill-claim.ts | 3 +++ .../medusa/src/api/routes/admin/orders/fulfill-swap.ts | 3 +++ .../medusa/src/api/routes/admin/orders/update-claim.ts | 6 ++++++ .../payment-collections/update-payment-collection.ts | 3 +++ .../src/api/routes/admin/products/create-product.ts | 6 ++++++ .../src/api/routes/admin/products/create-variant.ts | 3 +++ .../medusa/src/api/routes/admin/products/set-metadata.ts | 3 +++ .../src/api/routes/admin/products/update-product.ts | 6 ++++++ .../src/api/routes/admin/products/update-variant.ts | 3 +++ .../api/routes/admin/reservations/create-reservation.ts | 3 +++ .../api/routes/admin/reservations/update-reservation.ts | 3 +++ .../src/api/routes/admin/return-reasons/create-reason.ts | 3 +++ .../src/api/routes/admin/return-reasons/update-reason.ts | 3 +++ .../admin/shipping-options/create-shipping-option.ts | 3 +++ .../admin/shipping-options/update-shipping-option.ts | 3 +++ .../admin/shipping-profiles/update-shipping-profile.ts | 3 +++ .../routes/admin/stock-locations/create-stock-location.ts | 3 +++ .../routes/admin/stock-locations/update-stock-location.ts | 3 +++ .../medusa/src/api/routes/admin/store/update-store.ts | 3 +++ packages/medusa/src/api/routes/admin/users/update-user.ts | 3 +++ .../src/api/routes/store/carts/create-line-item/index.ts | 3 +++ .../medusa/src/api/routes/store/carts/update-line-item.ts | 3 +++ .../src/api/routes/store/customers/update-customer.ts | 3 +++ packages/medusa/src/models/address.ts | 3 +++ packages/medusa/src/models/cart.ts | 3 +++ packages/medusa/src/models/claim-image.ts | 3 +++ packages/medusa/src/models/claim-item.ts | 3 +++ packages/medusa/src/models/claim-order.ts | 3 +++ packages/medusa/src/models/claim-tag.ts | 3 +++ packages/medusa/src/models/custom-shipping-option.ts | 3 +++ packages/medusa/src/models/customer-group.ts | 3 +++ packages/medusa/src/models/customer.ts | 3 +++ .../src/models/discount-condition-customer-group.ts | 3 +++ .../src/models/discount-condition-product-collection.ts | 3 +++ .../medusa/src/models/discount-condition-product-tag.ts | 3 +++ .../medusa/src/models/discount-condition-product-type.ts | 3 +++ packages/medusa/src/models/discount-condition-product.ts | 3 +++ packages/medusa/src/models/discount-condition.ts | 3 +++ packages/medusa/src/models/discount-rule.ts | 3 +++ packages/medusa/src/models/discount.ts | 3 +++ packages/medusa/src/models/draft-order.ts | 3 +++ packages/medusa/src/models/fulfillment.ts | 3 +++ packages/medusa/src/models/gift-card.ts | 3 +++ packages/medusa/src/models/image.ts | 3 +++ packages/medusa/src/models/invite.ts | 3 +++ packages/medusa/src/models/line-item-adjustment.ts | 3 +++ packages/medusa/src/models/line-item-tax-line.ts | 3 +++ packages/medusa/src/models/line-item.ts | 3 +++ packages/medusa/src/models/order.ts | 3 +++ packages/medusa/src/models/payment-collection.ts | 3 +++ packages/medusa/src/models/payment.ts | 3 +++ packages/medusa/src/models/product-collection.ts | 3 +++ packages/medusa/src/models/product-option-value.ts | 3 +++ packages/medusa/src/models/product-option.ts | 3 +++ packages/medusa/src/models/product-tag.ts | 3 +++ packages/medusa/src/models/product-tax-rate.ts | 3 +++ packages/medusa/src/models/product-type-tax-rate.ts | 3 +++ packages/medusa/src/models/product-type.ts | 3 +++ packages/medusa/src/models/product-variant.ts | 3 +++ packages/medusa/src/models/product.ts | 3 +++ packages/medusa/src/models/refund.ts | 3 +++ packages/medusa/src/models/region.ts | 3 +++ packages/medusa/src/models/return-item.ts | 3 +++ packages/medusa/src/models/return-reason.ts | 3 +++ packages/medusa/src/models/return.ts | 3 +++ packages/medusa/src/models/sales-channel.ts | 8 ++++++++ packages/medusa/src/models/shipping-method-tax-line.ts | 3 +++ packages/medusa/src/models/shipping-option.ts | 3 +++ packages/medusa/src/models/shipping-profile.ts | 3 +++ packages/medusa/src/models/shipping-tax-rate.ts | 3 +++ packages/medusa/src/models/store.ts | 3 +++ packages/medusa/src/models/swap.ts | 3 +++ packages/medusa/src/models/tax-line.ts | 3 +++ packages/medusa/src/models/tax-rate.ts | 3 +++ packages/medusa/src/models/tracking-link.ts | 3 +++ packages/medusa/src/models/user.ts | 3 +++ 95 files changed, 303 insertions(+) diff --git a/packages/generated/client-types/src/lib/models/SalesChannel.ts b/packages/generated/client-types/src/lib/models/SalesChannel.ts index a20dd7ecc5..0c052c4f98 100644 --- a/packages/generated/client-types/src/lib/models/SalesChannel.ts +++ b/packages/generated/client-types/src/lib/models/SalesChannel.ts @@ -41,4 +41,8 @@ export interface SalesChannel { * The date with timezone at which the resource was deleted. */ deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata?: Record | null } diff --git a/packages/medusa/src/api/routes/admin/collections/create-collection.ts b/packages/medusa/src/api/routes/admin/collections/create-collection.ts index 2e5155f369..74d0afa938 100644 --- a/packages/medusa/src/api/routes/admin/collections/create-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/create-collection.ts @@ -100,6 +100,9 @@ export default async (req: Request, res: Response) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostCollectionsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/collections/update-collection.ts b/packages/medusa/src/api/routes/admin/collections/update-collection.ts index 69b5e44f2c..b9c826b091 100644 --- a/packages/medusa/src/api/routes/admin/collections/update-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/update-collection.ts @@ -103,6 +103,9 @@ export default async (req: Request, res: Response) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostCollectionsCollectionReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts index dbb818637c..fe0c1afd44 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts @@ -97,6 +97,9 @@ export default async (req: Request, res: Response) => { * metadata: * type: object * description: Metadata of the customer group. + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostCustomerGroupsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts index 02ffb28b67..6d4e267640 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts @@ -116,6 +116,9 @@ export default async (req: Request, res: Response) => { * metadata: * description: "Metadata of the customer group." * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostCustomerGroupsGroupReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/customers/create-customer.ts b/packages/medusa/src/api/routes/admin/customers/create-customer.ts index 7e0e9619f4..37d6f00dc5 100644 --- a/packages/medusa/src/api/routes/admin/customers/create-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/create-customer.ts @@ -112,6 +112,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostCustomersReq { @IsEmail() diff --git a/packages/medusa/src/api/routes/admin/customers/update-customer.ts b/packages/medusa/src/api/routes/admin/customers/update-customer.ts index 3011981b10..9e220aef98 100644 --- a/packages/medusa/src/api/routes/admin/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/update-customer.ts @@ -159,6 +159,9 @@ class Group { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostCustomersCustomerReq { @IsEmail() diff --git a/packages/medusa/src/api/routes/admin/discounts/create-discount.ts b/packages/medusa/src/api/routes/admin/discounts/create-discount.ts index 5732e89434..e66b251177 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-discount.ts @@ -225,6 +225,9 @@ export default async (req: Request, res: Response) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostDiscountsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts b/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts index 80b70c9557..0d762557e2 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts @@ -112,6 +112,9 @@ export default async (req: Request, res: Response) => { * metadata: * type: object * description: An optional set of key-value pairs to hold additional information. + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostDiscountsDiscountDynamicCodesReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/discounts/update-discount.ts b/packages/medusa/src/api/routes/admin/discounts/update-discount.ts index a7ace2ee1e..003e84d54e 100644 --- a/packages/medusa/src/api/routes/admin/discounts/update-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/update-discount.ts @@ -200,6 +200,9 @@ export default async (req: Request, res: Response) => { * metadata: * description: An object containing metadata of the discount * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostDiscountsDiscountReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts index f49d34bcfc..e40b2581a4 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts @@ -212,6 +212,9 @@ enum Status { * metadata: * description: The optional key-value map with additional details about the line item. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" * region_id: * description: The ID of the region for the draft order * type: string @@ -252,6 +255,9 @@ enum Status { * metadata: * description: The optional key-value map with additional details about the Draft Order. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostDraftOrdersReq { @IsEnum(Status) diff --git a/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts index cf8a78ba17..cfd078de31 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts @@ -167,6 +167,9 @@ export default async (req, res) => { * metadata: * description: The optional key-value map with additional details about the Line Item. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostDraftOrdersDraftOrderLineItemsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts index cc9bf222f8..3861c83ef2 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts @@ -162,6 +162,9 @@ export default async (req, res) => { * metadata: * description: The optional key-value map with additional details about the Line Item. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostDraftOrdersDraftOrderLineItemsItemReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts index 1649948a2c..0a503e56da 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts @@ -108,6 +108,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostGiftCardsReq { @IsOptional() diff --git a/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts index e937323ebb..2248f8be88 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts @@ -110,6 +110,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostGiftCardsGiftCardReq { @IsOptional() diff --git a/packages/medusa/src/api/routes/admin/inventory-items/create-inventory-item.ts b/packages/medusa/src/api/routes/admin/inventory-items/create-inventory-item.ts index 5d8f8ea129..763fe45e23 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/create-inventory-item.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/create-inventory-item.ts @@ -181,6 +181,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostInventoryItemsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts b/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts index dfe167f5b5..51ad316620 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts @@ -115,6 +115,9 @@ export default async (req: Request, res: Response) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostOrderEditsEditLineItemsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/orders/create-claim.ts b/packages/medusa/src/api/routes/admin/orders/create-claim.ts index a74b7a0b5b..edaa43d45c 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-claim.ts @@ -408,6 +408,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostOrdersOrderClaimsReq { @IsEnum(ClaimType) diff --git a/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts b/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts index 4e318a66e6..96b4f752a1 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts @@ -228,6 +228,9 @@ export const updateInventoryAndReservations = async ( * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostOrdersOrderFulfillmentsReq { @IsArray() diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts index ff4fe7bb5e..4cc7d1f2ad 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts @@ -143,6 +143,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" * no_notification: * description: If set to `true`, no notification will be sent to the customer related to this Claim. * type: boolean diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts index 6c7c13a3a4..5b741c2e36 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts @@ -150,6 +150,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" * no_notification: * description: If set to `true`, no notification will be sent to the customer related to this swap. * type: boolean diff --git a/packages/medusa/src/api/routes/admin/orders/update-claim.ts b/packages/medusa/src/api/routes/admin/orders/update-claim.ts index 8d7deec955..0f2148c943 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-claim.ts @@ -168,6 +168,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" * shipping_methods: * description: The Shipping Methods to send the additional Line Items with. * type: array @@ -192,6 +195,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostOrdersOrderClaimsClaimReq { @IsArray() diff --git a/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts b/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts index 460b2f465b..ffbf9afab5 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts @@ -95,6 +95,9 @@ export default async (req, res) => { * metadata: * description: A set of key-value pairs to hold additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminUpdatePaymentCollectionsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/products/create-product.ts b/packages/medusa/src/api/routes/admin/products/create-product.ts index a7f2fddc18..606e6a9518 100644 --- a/packages/medusa/src/api/routes/admin/products/create-product.ts +++ b/packages/medusa/src/api/routes/admin/products/create-product.ts @@ -500,6 +500,9 @@ class ProductVariantReq { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/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. @@ -570,6 +573,9 @@ class ProductVariantReq { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostProductsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/products/create-variant.ts b/packages/medusa/src/api/routes/admin/products/create-variant.ts index a087b56c20..b4c854a2d1 100644 --- a/packages/medusa/src/api/routes/admin/products/create-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/create-variant.ts @@ -225,6 +225,9 @@ class ProductVariantOptionReq { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/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. diff --git a/packages/medusa/src/api/routes/admin/products/set-metadata.ts b/packages/medusa/src/api/routes/admin/products/set-metadata.ts index ec7b2ec7b8..6bbf084caa 100644 --- a/packages/medusa/src/api/routes/admin/products/set-metadata.ts +++ b/packages/medusa/src/api/routes/admin/products/set-metadata.ts @@ -10,6 +10,9 @@ import { PricingService } from "../../../../services" * operationId: "PostProductsProductMetadata" * summary: "Set Metadata" * description: "Set the metadata of a Product. It can be any key-value pair, which allows adding custom data to a product." + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Product. diff --git a/packages/medusa/src/api/routes/admin/products/update-product.ts b/packages/medusa/src/api/routes/admin/products/update-product.ts index 889c34a4f3..8a9681b885 100644 --- a/packages/medusa/src/api/routes/admin/products/update-product.ts +++ b/packages/medusa/src/api/routes/admin/products/update-product.ts @@ -492,6 +492,9 @@ class ProductVariantReq { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/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. @@ -563,6 +566,9 @@ class ProductVariantReq { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostProductsProductReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/products/update-variant.ts b/packages/medusa/src/api/routes/admin/products/update-variant.ts index 59a430544a..43b352e7ce 100644 --- a/packages/medusa/src/api/routes/admin/products/update-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/update-variant.ts @@ -202,6 +202,9 @@ class ProductVariantOptionReq { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/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. diff --git a/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts index 5e978d982f..883411ccf7 100644 --- a/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts @@ -118,6 +118,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostReservationsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts index 5e050a00de..9abb5a4678 100644 --- a/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts @@ -111,6 +111,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostReservationsReservationReq { @IsNumber() diff --git a/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts index ad4c0bf738..59ea35abd3 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts @@ -113,6 +113,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostReturnReasonsReq { @IsString() diff --git a/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts index e63b46433c..12063cd100 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts @@ -110,6 +110,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostReturnReasonsReasonReq { @IsOptional() diff --git a/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts index 57645d9fc9..47ffd41d64 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts @@ -181,6 +181,9 @@ class OptionRequirement { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" * includes_tax: * description: "Tax included in prices of shipping option" * x-featureFlag: "tax_inclusive_pricing" diff --git a/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts index afe1768ad7..f3f3cbb265 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts @@ -146,6 +146,9 @@ class OptionRequirement { * metadata: * description: "An optional set of key-value pairs with additional information." * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" * requirements: * description: "The requirements that must be satisfied for the Shipping Option to be available." * type: array diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts index ab0ecccbcc..70aa614a2f 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts @@ -113,6 +113,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" * type: * description: The type of the Shipping Profile * type: string diff --git a/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts index 459dd4c4c5..e32eeb5026 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts @@ -180,6 +180,9 @@ class StockLocationAddress { * type: object * description: An optional key-value map with additional details * 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" * address: * description: A new stock location address to create and associate with the stock location. Only required if `address_id` is not provided. * $ref: "#/components/schemas/StockLocationAddressInput" diff --git a/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts index e5b80a57b5..ddf99a52be 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts @@ -131,6 +131,9 @@ class StockLocationAddress { * type: object * description: An optional key-value map with additional details * 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" * address: * $ref: "#/components/schemas/StockLocationAddressInput" */ diff --git a/packages/medusa/src/api/routes/admin/store/update-store.ts b/packages/medusa/src/api/routes/admin/store/update-store.ts index bc9d4ef71d..7cf77f916f 100644 --- a/packages/medusa/src/api/routes/admin/store/update-store.ts +++ b/packages/medusa/src/api/routes/admin/store/update-store.ts @@ -115,6 +115,9 @@ export default async (req, res) => { * metadata: * description: "An optional set of key-value pairs with additional information." * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminPostStoreReq { @IsOptional() diff --git a/packages/medusa/src/api/routes/admin/users/update-user.ts b/packages/medusa/src/api/routes/admin/users/update-user.ts index 497dc47d1f..b6338a73f6 100644 --- a/packages/medusa/src/api/routes/admin/users/update-user.ts +++ b/packages/medusa/src/api/routes/admin/users/update-user.ts @@ -103,6 +103,9 @@ export default async (req, res) => { * metadata: * description: An optional set of key-value pairs with additional information. * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class AdminUpdateUserRequest { @IsString() diff --git a/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts b/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts index 52ad53cd86..399c1b3779 100644 --- a/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts +++ b/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts @@ -157,6 +157,9 @@ export default async (req, res) => { * metadata: * type: object * description: An optional key-value map with additional details about the Line Item. + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class StorePostCartsCartLineItemsReq { @IsString() diff --git a/packages/medusa/src/api/routes/store/carts/update-line-item.ts b/packages/medusa/src/api/routes/store/carts/update-line-item.ts index cf8622a040..89e5c8b64f 100644 --- a/packages/medusa/src/api/routes/store/carts/update-line-item.ts +++ b/packages/medusa/src/api/routes/store/carts/update-line-item.ts @@ -127,6 +127,9 @@ export default async (req, res) => { * metadata: * type: object * description: An optional key-value map with additional details about the Line Item. If omitted, the metadata will remain unchanged." + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class StorePostCartsCartLineItemsItemReq { @IsInt() diff --git a/packages/medusa/src/api/routes/store/customers/update-customer.ts b/packages/medusa/src/api/routes/store/customers/update-customer.ts index 8fc2184358..28e6d665b2 100644 --- a/packages/medusa/src/api/routes/store/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/update-customer.ts @@ -116,6 +116,9 @@ export default async (req, res) => { * metadata: * description: "Additional custom data about the customer." * type: object + * externalDocs: + * description: "Learn about the metadata attribute, and how to delete and update it." + * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */ export class StorePostCustomersCustomerReq { @IsOptional() diff --git a/packages/medusa/src/models/address.ts b/packages/medusa/src/models/address.ts index 64f8d36f6f..ce95164387 100644 --- a/packages/medusa/src/models/address.ts +++ b/packages/medusa/src/models/address.ts @@ -178,4 +178,7 @@ export class Address extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/cart.ts b/packages/medusa/src/models/cart.ts index fc63cb2d26..cd7147f52d 100644 --- a/packages/medusa/src/models/cart.ts +++ b/packages/medusa/src/models/cart.ts @@ -177,6 +177,9 @@ * nullable: true * 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" * shipping_total: * description: The total of shipping * type: integer diff --git a/packages/medusa/src/models/claim-image.ts b/packages/medusa/src/models/claim-image.ts index 6245dba114..6d22b898b5 100644 --- a/packages/medusa/src/models/claim-image.ts +++ b/packages/medusa/src/models/claim-image.ts @@ -82,4 +82,7 @@ export class ClaimImage extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/claim-item.ts b/packages/medusa/src/models/claim-item.ts index 864645e9fe..8deeb347b6 100644 --- a/packages/medusa/src/models/claim-item.ts +++ b/packages/medusa/src/models/claim-item.ts @@ -184,4 +184,7 @@ export class ClaimItem extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/claim-order.ts b/packages/medusa/src/models/claim-order.ts index 52100acd78..b0e68316ce 100644 --- a/packages/medusa/src/models/claim-order.ts +++ b/packages/medusa/src/models/claim-order.ts @@ -259,6 +259,9 @@ export class ClaimOrder extends SoftDeletableEntity { * nullable: true * 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" * no_notification: * description: Flag for describing whether or not notifications related to this should be send. * nullable: true diff --git a/packages/medusa/src/models/claim-tag.ts b/packages/medusa/src/models/claim-tag.ts index 471e77f9b7..0171a8f6a9 100644 --- a/packages/medusa/src/models/claim-tag.ts +++ b/packages/medusa/src/models/claim-tag.ts @@ -58,4 +58,7 @@ export class ClaimTag extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/custom-shipping-option.ts b/packages/medusa/src/models/custom-shipping-option.ts index 4e7aca9813..366bc24ce9 100644 --- a/packages/medusa/src/models/custom-shipping-option.ts +++ b/packages/medusa/src/models/custom-shipping-option.ts @@ -105,4 +105,7 @@ export class CustomShippingOption extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/customer-group.ts b/packages/medusa/src/models/customer-group.ts index 812e006acf..9cfbdcd634 100644 --- a/packages/medusa/src/models/customer-group.ts +++ b/packages/medusa/src/models/customer-group.ts @@ -82,4 +82,7 @@ export class CustomerGroup extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/customer.ts b/packages/medusa/src/models/customer.ts index eee78e2ca9..ab584cd198 100644 --- a/packages/medusa/src/models/customer.ts +++ b/packages/medusa/src/models/customer.ts @@ -170,4 +170,7 @@ export class Customer extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/discount-condition-customer-group.ts b/packages/medusa/src/models/discount-condition-customer-group.ts index 0874e3f667..7f7647009c 100644 --- a/packages/medusa/src/models/discount-condition-customer-group.ts +++ b/packages/medusa/src/models/discount-condition-customer-group.ts @@ -78,4 +78,7 @@ export class DiscountConditionCustomerGroup { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/discount-condition-product-collection.ts b/packages/medusa/src/models/discount-condition-product-collection.ts index cfaf50364f..0292a451ed 100644 --- a/packages/medusa/src/models/discount-condition-product-collection.ts +++ b/packages/medusa/src/models/discount-condition-product-collection.ts @@ -80,4 +80,7 @@ export class DiscountConditionProductCollection { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/discount-condition-product-tag.ts b/packages/medusa/src/models/discount-condition-product-tag.ts index ae85efb2b6..441504e1f7 100644 --- a/packages/medusa/src/models/discount-condition-product-tag.ts +++ b/packages/medusa/src/models/discount-condition-product-tag.ts @@ -80,4 +80,7 @@ export class DiscountConditionProductTag { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/discount-condition-product-type.ts b/packages/medusa/src/models/discount-condition-product-type.ts index ddf8f9c08b..3e0f431591 100644 --- a/packages/medusa/src/models/discount-condition-product-type.ts +++ b/packages/medusa/src/models/discount-condition-product-type.ts @@ -80,4 +80,7 @@ export class DiscountConditionProductType { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/discount-condition-product.ts b/packages/medusa/src/models/discount-condition-product.ts index c1b6e0b240..4896de54c5 100644 --- a/packages/medusa/src/models/discount-condition-product.ts +++ b/packages/medusa/src/models/discount-condition-product.ts @@ -80,4 +80,7 @@ export class DiscountConditionProduct { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/discount-condition.ts b/packages/medusa/src/models/discount-condition.ts index 26b80bdefa..b32679e322 100644 --- a/packages/medusa/src/models/discount-condition.ts +++ b/packages/medusa/src/models/discount-condition.ts @@ -230,4 +230,7 @@ export class DiscountCondition extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/discount-rule.ts b/packages/medusa/src/models/discount-rule.ts index bdf9abb6bf..112c362109 100644 --- a/packages/medusa/src/models/discount-rule.ts +++ b/packages/medusa/src/models/discount-rule.ts @@ -118,4 +118,7 @@ export class DiscountRule extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/discount.ts b/packages/medusa/src/models/discount.ts index 8293ef473a..1a827d8cff 100644 --- a/packages/medusa/src/models/discount.ts +++ b/packages/medusa/src/models/discount.ts @@ -194,4 +194,7 @@ export class Discount extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/draft-order.ts b/packages/medusa/src/models/draft-order.ts index 703a3b8dfa..45ab0c176d 100644 --- a/packages/medusa/src/models/draft-order.ts +++ b/packages/medusa/src/models/draft-order.ts @@ -167,4 +167,7 @@ export class DraftOrder extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/fulfillment.ts b/packages/medusa/src/models/fulfillment.ts index 57d564bc1c..a83d03cbd9 100644 --- a/packages/medusa/src/models/fulfillment.ts +++ b/packages/medusa/src/models/fulfillment.ts @@ -220,4 +220,7 @@ export class Fulfillment extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/gift-card.ts b/packages/medusa/src/models/gift-card.ts index ed9f3c512e..4896210ce4 100644 --- a/packages/medusa/src/models/gift-card.ts +++ b/packages/medusa/src/models/gift-card.ts @@ -149,4 +149,7 @@ export class GiftCard extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/image.ts b/packages/medusa/src/models/image.ts index cf3055a257..58ea5236cc 100644 --- a/packages/medusa/src/models/image.ts +++ b/packages/medusa/src/models/image.ts @@ -57,4 +57,7 @@ export class Image extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/invite.ts b/packages/medusa/src/models/invite.ts index dfbe065bf9..2bf43c380b 100644 --- a/packages/medusa/src/models/invite.ts +++ b/packages/medusa/src/models/invite.ts @@ -100,4 +100,7 @@ export class Invite extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/line-item-adjustment.ts b/packages/medusa/src/models/line-item-adjustment.ts index 3734e38752..d3bfa91ed7 100644 --- a/packages/medusa/src/models/line-item-adjustment.ts +++ b/packages/medusa/src/models/line-item-adjustment.ts @@ -101,4 +101,7 @@ export class LineItemAdjustment { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/line-item-tax-line.ts b/packages/medusa/src/models/line-item-tax-line.ts index 47bf29fcba..31fe76e241 100644 --- a/packages/medusa/src/models/line-item-tax-line.ts +++ b/packages/medusa/src/models/line-item-tax-line.ts @@ -83,4 +83,7 @@ export class LineItemTaxLine extends TaxLine { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/line-item.ts b/packages/medusa/src/models/line-item.ts index 7031cf96d8..3be2a03143 100644 --- a/packages/medusa/src/models/line-item.ts +++ b/packages/medusa/src/models/line-item.ts @@ -381,4 +381,7 @@ export class LineItem extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/order.ts b/packages/medusa/src/models/order.ts index 383fdf695c..6c39be60db 100644 --- a/packages/medusa/src/models/order.ts +++ b/packages/medusa/src/models/order.ts @@ -586,4 +586,7 @@ export class Order extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/payment-collection.ts b/packages/medusa/src/models/payment-collection.ts index e24e474e07..b37ff6ba5a 100644 --- a/packages/medusa/src/models/payment-collection.ts +++ b/packages/medusa/src/models/payment-collection.ts @@ -202,4 +202,7 @@ export class PaymentCollection extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/payment.ts b/packages/medusa/src/models/payment.ts index 5a4e3351e2..f597700be5 100644 --- a/packages/medusa/src/models/payment.ts +++ b/packages/medusa/src/models/payment.ts @@ -200,4 +200,7 @@ export class Payment extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/product-collection.ts b/packages/medusa/src/models/product-collection.ts index 0c0a205f35..5d0cccb632 100644 --- a/packages/medusa/src/models/product-collection.ts +++ b/packages/medusa/src/models/product-collection.ts @@ -83,4 +83,7 @@ export class ProductCollection extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/product-option-value.ts b/packages/medusa/src/models/product-option-value.ts index 037aa01de8..2e2f2fc38c 100644 --- a/packages/medusa/src/models/product-option-value.ts +++ b/packages/medusa/src/models/product-option-value.ts @@ -104,4 +104,7 @@ export class ProductOptionValue extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/product-option.ts b/packages/medusa/src/models/product-option.ts index bd509c0e50..1b63360ac5 100644 --- a/packages/medusa/src/models/product-option.ts +++ b/packages/medusa/src/models/product-option.ts @@ -94,4 +94,7 @@ export class ProductOption extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/product-tag.ts b/packages/medusa/src/models/product-tag.ts index 7d6ea7f27b..273d554c3e 100644 --- a/packages/medusa/src/models/product-tag.ts +++ b/packages/medusa/src/models/product-tag.ts @@ -57,4 +57,7 @@ export class ProductTag extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/product-tax-rate.ts b/packages/medusa/src/models/product-tax-rate.ts index 7c1ffa7ab3..1e031b00d2 100644 --- a/packages/medusa/src/models/product-tax-rate.ts +++ b/packages/medusa/src/models/product-tax-rate.ts @@ -81,4 +81,7 @@ export class ProductTaxRate { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/product-type-tax-rate.ts b/packages/medusa/src/models/product-type-tax-rate.ts index d8ff590f1a..528dc5a953 100644 --- a/packages/medusa/src/models/product-type-tax-rate.ts +++ b/packages/medusa/src/models/product-type-tax-rate.ts @@ -80,4 +80,7 @@ export class ProductTypeTaxRate { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/product-type.ts b/packages/medusa/src/models/product-type.ts index d4fe28b40e..2eabb10fc2 100644 --- a/packages/medusa/src/models/product-type.ts +++ b/packages/medusa/src/models/product-type.ts @@ -57,4 +57,7 @@ export class ProductType extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/product-variant.ts b/packages/medusa/src/models/product-variant.ts index a6641dd5f4..a130656480 100644 --- a/packages/medusa/src/models/product-variant.ts +++ b/packages/medusa/src/models/product-variant.ts @@ -270,6 +270,9 @@ export class ProductVariant extends SoftDeletableEntity { * nullable: true * 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" * purchasable: * description: | * Only used with the inventory modules. diff --git a/packages/medusa/src/models/product.ts b/packages/medusa/src/models/product.ts index b7a95b4128..95c84826c1 100644 --- a/packages/medusa/src/models/product.ts +++ b/packages/medusa/src/models/product.ts @@ -432,4 +432,7 @@ export class Product extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/refund.ts b/packages/medusa/src/models/refund.ts index dc1c944f58..0301e95913 100644 --- a/packages/medusa/src/models/refund.ts +++ b/packages/medusa/src/models/refund.ts @@ -141,4 +141,7 @@ export class Refund extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/region.ts b/packages/medusa/src/models/region.ts index e53706e215..f36dcfcdcc 100644 --- a/packages/medusa/src/models/region.ts +++ b/packages/medusa/src/models/region.ts @@ -217,4 +217,7 @@ export class Region extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/return-item.ts b/packages/medusa/src/models/return-item.ts index bc242d3de0..80f1f9a17d 100644 --- a/packages/medusa/src/models/return-item.ts +++ b/packages/medusa/src/models/return-item.ts @@ -119,4 +119,7 @@ export class ReturnItem { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/return-reason.ts b/packages/medusa/src/models/return-reason.ts index 2adc92da68..e95d1e977c 100644 --- a/packages/medusa/src/models/return-reason.ts +++ b/packages/medusa/src/models/return-reason.ts @@ -112,4 +112,7 @@ export class ReturnReason extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/return.ts b/packages/medusa/src/models/return.ts index 91b4847ac9..4533ac2ad2 100644 --- a/packages/medusa/src/models/return.ts +++ b/packages/medusa/src/models/return.ts @@ -216,4 +216,7 @@ export class Return extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/sales-channel.ts b/packages/medusa/src/models/sales-channel.ts index 75202d33af..8c24881188 100644 --- a/packages/medusa/src/models/sales-channel.ts +++ b/packages/medusa/src/models/sales-channel.ts @@ -84,4 +84,12 @@ export class SalesChannel extends SoftDeletableEntity { * nullable: true * type: string * format: date-time + * metadata: + * description: An optional key-value map with additional details + * nullable: true + * 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" */ diff --git a/packages/medusa/src/models/shipping-method-tax-line.ts b/packages/medusa/src/models/shipping-method-tax-line.ts index 5b234ce299..e5c31bb7a0 100644 --- a/packages/medusa/src/models/shipping-method-tax-line.ts +++ b/packages/medusa/src/models/shipping-method-tax-line.ts @@ -83,4 +83,7 @@ export class ShippingMethodTaxLine extends TaxLine { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/shipping-option.ts b/packages/medusa/src/models/shipping-option.ts index 9b77cbb179..83a75abb9d 100644 --- a/packages/medusa/src/models/shipping-option.ts +++ b/packages/medusa/src/models/shipping-option.ts @@ -195,4 +195,7 @@ export class ShippingOption extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/shipping-profile.ts b/packages/medusa/src/models/shipping-profile.ts index bd6215aaae..1237249a7d 100644 --- a/packages/medusa/src/models/shipping-profile.ts +++ b/packages/medusa/src/models/shipping-profile.ts @@ -113,4 +113,7 @@ export class ShippingProfile extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/shipping-tax-rate.ts b/packages/medusa/src/models/shipping-tax-rate.ts index 826bb60d06..7601452aa1 100644 --- a/packages/medusa/src/models/shipping-tax-rate.ts +++ b/packages/medusa/src/models/shipping-tax-rate.ts @@ -80,4 +80,7 @@ export class ShippingTaxRate { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/store.ts b/packages/medusa/src/models/store.ts index 734afb62ec..3204fddb7f 100644 --- a/packages/medusa/src/models/store.ts +++ b/packages/medusa/src/models/store.ts @@ -161,4 +161,7 @@ export class Store extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/swap.ts b/packages/medusa/src/models/swap.ts index 7f40a0ff48..00a81b2753 100644 --- a/packages/medusa/src/models/swap.ts +++ b/packages/medusa/src/models/swap.ts @@ -276,4 +276,7 @@ export class Swap extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/tax-line.ts b/packages/medusa/src/models/tax-line.ts index ab71753d2b..e873524a6a 100644 --- a/packages/medusa/src/models/tax-line.ts +++ b/packages/medusa/src/models/tax-line.ts @@ -60,4 +60,7 @@ export class TaxLine extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/tax-rate.ts b/packages/medusa/src/models/tax-rate.ts index 5f4e0142b1..503b9a56c8 100644 --- a/packages/medusa/src/models/tax-rate.ts +++ b/packages/medusa/src/models/tax-rate.ts @@ -175,4 +175,7 @@ export class TaxRate extends BaseEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/tracking-link.ts b/packages/medusa/src/models/tracking-link.ts index 861b8fd2ad..d390be5e9c 100644 --- a/packages/medusa/src/models/tracking-link.ts +++ b/packages/medusa/src/models/tracking-link.ts @@ -95,4 +95,7 @@ export class TrackingLink extends SoftDeletableEntity { * nullable: true * 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" */ diff --git a/packages/medusa/src/models/user.ts b/packages/medusa/src/models/user.ts index f5b6430376..a6c8c92c2f 100644 --- a/packages/medusa/src/models/user.ts +++ b/packages/medusa/src/models/user.ts @@ -111,4 +111,7 @@ export class User extends SoftDeletableEntity { * nullable: true * 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" */