chore(oas): add link for additional info on metadata (#4613)

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<string, any> | null
 }

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()

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()

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()

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()

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()

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()

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()

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()

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()

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)

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()

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()

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()

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()

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()

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()

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)

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()

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

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

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()

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()

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()

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.

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.

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()

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.

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()

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()

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()

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()

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"

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

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

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"

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"
  */

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()

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()

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()

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()

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()

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"
  */

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

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"
  */

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"
  */

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

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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.

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */

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"
  */