chore(docs): Generated API Reference (#4706)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

docs/api/admin/components/schemas/Product.yaml

@@ -1,8 +1,10 @@
 title: Product
 description: >-
-  Products are a grouping of Product Variants that have common properties such
-  as images and descriptions. Products can have multiple options which define
-  the properties that Product Variants differ by.
+  A product is a saleable item that holds general information such as name or
+  description. It must include at least one Product Variant, where each product
+  variant defines different options to purchase the product with (for example,
+  different sizes or colors). The prices and inventory of the product are
+  defined on the variant level.
 type: object
 required:
   - collection_id
@@ -70,8 +72,9 @@ properties:
       - rejected
     default: draft
   images:
-    description: Images of the Product. Available if the relation `images` is expanded.
+    description: The details of the product's images.
     type: array
+    x-expandable: images
     items:
       $ref: ./Image.yaml
   thumbnail:
@@ -81,38 +84,49 @@ properties:
     format: uri
   options:
     description: >-
-      The Product Options that are defined for the Product. Product Variants of
-      the Product will have a unique combination of Product Option Values.
-      Available if the relation `options` is expanded.
+      The details of the Product Options that are defined for the Product. The
+      product's variants will have a unique combination of values of the
+      product's options.
     type: array
+    x-expandable: options
     items:
       $ref: ./ProductOption.yaml
   variants:
     description: >-
-      The Product Variants that belong to the Product. Each will have a unique
-      combination of Product Option Values. Available if the relation `variants`
-      is expanded.
+      The details of the Product Variants that belong to the Product. Each will
+      have a unique combination of values of the product's options.
     type: array
+    x-expandable: variants
     items:
       $ref: ./ProductVariant.yaml
   categories:
-    description: >-
-      The product's associated categories. Available if the relation
-      `categories` are expanded.
+    description: The details of the product categories that this product belongs to.
     type: array
+    x-expandable: categories
+    x-featureFlag: product_categories
     items:
       $ref: ./ProductCategory.yaml
   profile_id:
     description: >-
-      The ID of the Shipping Profile that the Product belongs to. Shipping
-      Profiles have a set of defined Shipping Options that can be used to
-      Fulfill a given set of Products.
+      The ID of the shipping profile that the product belongs to. The shipping
+      profile has a set of defined shipping options that can be used to fulfill
+      the product.
     type: string
     example: sp_01G1G5V239ENSZ5MV4JAR737BM
   profile:
-    description: Available if the relation `profile` is expanded.
+    description: >-
+      The details of the shipping profile that the product belongs to. The
+      shipping profile has a set of defined shipping options that can be used to
+      fulfill the product.
+    x-expandable: profile
     nullable: true
     $ref: ./ShippingProfile.yaml
+  profiles:
+    description: Available if the relation `profiles` is expanded.
+    nullable: true
+    type: array
+    items:
+      $ref: ./ShippingProfile.yaml
   weight:
     description: >-
       The weight of the Product Variant. May be used in shipping rate
@@ -172,30 +186,29 @@ properties:
     type: string
     example: null
   collection_id:
-    description: The Product Collection that the Product belongs to
+    description: The ID of the product collection that the product belongs to.
     nullable: true
     type: string
     example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
   collection:
-    description: >-
-      A product collection object. Available if the relation `collection` is
-      expanded.
+    description: The details of the product collection that the product belongs to.
+    x-expandable: collection
     nullable: true
     $ref: ./ProductCollection.yaml
   type_id:
-    description: The Product type that the Product belongs to
+    description: The ID of the product type that the product belongs to.
     nullable: true
     type: string
     example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
   type:
-    description: Available if the relation `type` is expanded.
+    description: The details of the product type that the product belongs to.
+    x-expandable: type
     nullable: true
     $ref: ./ProductType.yaml
   tags:
-    description: >-
-      The Product Tags assigned to the Product. Available if the relation `tags`
-      is expanded.
+    description: The details of the product tags used in this product.
     type: array
+    x-expandable: type
     items:
       $ref: ./ProductTag.yaml
   discountable:
@@ -210,10 +223,9 @@ properties:
     type: string
     example: null
   sales_channels:
-    description: >-
-      The sales channels the product is associated with. Available if the
-      relation `sales_channels` is expanded.
+    description: The details of the sales channels this product is available in.
     type: array
+    x-expandable: sales_channels
     items:
       $ref: ./SalesChannel.yaml
   created_at:
@@ -235,3 +247,7 @@ properties:
     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