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/Fulfillment.yaml

@@ -1,12 +1,10 @@
 title: Fulfillment
 description: >-
-  Fulfillments are created once store operators can prepare the purchased goods.
+  A Fulfillment is created once an admin can prepare the purchased goods.
   Fulfillments will eventually be shipped and hold information about how to
-  track shipments. Fulfillments are created through a provider, which is
-  typically an external shipping aggregator, shipping partner og 3PL, most
-  plugins will have asynchronous communications with these providers through
-  webhooks in order to automatically update and synchronize the state of
-  Fulfillments.
+  track shipments. Fulfillments are created through a fulfillment provider,
+  which typically integrates a third-party shipping service. Fulfillments can be
+  associated with orders, claims, swaps, and returns.
 type: object
 required:
   - canceled_at
@@ -30,61 +28,67 @@ properties:
     type: string
     example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
   claim_order_id:
-    description: The id of the Claim that the Fulfillment belongs to.
+    description: The ID of the Claim that the Fulfillment belongs to.
     nullable: true
     type: string
     example: null
   claim_order:
-    description: A claim order object. Available if the relation `claim_order` is expanded.
+    description: The details of the claim that the fulfillment may belong to.
+    x-expandable: claim_order
     nullable: true
     type: object
   swap_id:
-    description: The id of the Swap that the Fulfillment belongs to.
+    description: The ID of the Swap that the Fulfillment belongs to.
     nullable: true
     type: string
     example: null
   swap:
-    description: A swap object. Available if the relation `swap` is expanded.
+    description: The details of the swap that the fulfillment may belong to.
+    x-expandable: swap
     nullable: true
     type: object
   order_id:
-    description: The id of the Order that the Fulfillment belongs to.
+    description: The ID of the Order that the Fulfillment belongs to.
     nullable: true
     type: string
     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
   order:
-    description: An order object. Available if the relation `order` is expanded.
+    description: The details of the order that the fulfillment may belong to.
+    x-expandable: order
     nullable: true
     type: object
   provider_id:
     description: >-
-      The id of the Fulfillment Provider responsible for handling the
-      fulfillment
+      The ID of the Fulfillment Provider responsible for handling the
+      fulfillment.
     type: string
     example: manual
   provider:
-    description: Available if the relation `provider` is expanded.
+    description: >-
+      The details of the fulfillment provider responsible for handling the
+      fulfillment.
+    x-expandable: provider
     nullable: true
     $ref: ./FulfillmentProvider.yaml
   location_id:
-    description: The id of the stock location the fulfillment will be shipped from
+    description: The ID of the stock location the fulfillment will be shipped from
     nullable: true
     type: string
     example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
   items:
     description: >-
-      The Fulfillment Items in the Fulfillment - these hold information about
-      how many of each Line Item has been fulfilled. Available if the relation
-      `items` is expanded.
+      The Fulfillment Items in the Fulfillment. These hold information about how
+      many of each Line Item has been fulfilled.
     type: array
+    x-expandable: items
     items:
       $ref: ./FulfillmentItem.yaml
   tracking_links:
     description: >-
       The Tracking Links that can be used to track the status of the
-      Fulfillment, these will usually be provided by the Fulfillment Provider.
-      Available if the relation `tracking_links` is expanded.
+      Fulfillment. These will usually be provided by the Fulfillment Provider.
     type: array
+    x-expandable: tracking_links
     items:
       $ref: ./TrackingLink.yaml
   tracking_numbers:
@@ -141,3 +145,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