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

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