Add missing example descriptions

Fixes

Author: mcvinci

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/cart-line-item-api.doc.ts

@@ -21,6 +21,23 @@ const data: ReferenceEntityTemplateSchema = {
       type: 'CartLineItemApi',
     },
   ],
+  examples: {
+    description:
+      'Learn how to access line item information in cart line item action contexts.',
+    examples: [
+      {
+        codeblock: generateJsxCodeBlockForCartLineItemApi(
+          'Display the line item ID',
+          'id',
+        ),
+        description:
+          'Access the unique identifier of the current cart line item in line item detail contexts. This example shows how to use `shopify.cartLineItem.id` to retrieve the line item ID. This can be used for modifying the item, applying discounts, or implementing item-specific functionality.',
+      },
+    ],
+  },
+  category: 'Target APIs',
+  subCategory: 'Contextual APIs',
+  related: [],
   subSections: [
     {
       type: 'Generic',
@@ -44,23 +61,6 @@ const data: ReferenceEntityTemplateSchema = {
 `,
     },
   ],
-  examples: {
-    description:
-      'Learn how to access line item information in cart line item action contexts.',
-    examples: [
-      {
-        codeblock: generateJsxCodeBlockForCartLineItemApi(
-          'Display the line item ID',
-          'id',
-        ),
-        description:
-          'Access the unique identifier of the current cart line item in line item detail contexts. This example shows how to use `shopify.cartLineItem.id` to retrieve the line item ID. This can be used for modifying the item, applying discounts, or implementing item-specific functionality.',
-      },
-    ],
-  },
-  category: 'Target APIs',
-  subCategory: 'Contextual APIs',
-  related: [],
 };
 
 export default data;

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/customer-api.doc.ts

@@ -19,6 +19,23 @@ const data: ReferenceEntityTemplateSchema = {
       type: 'CustomerApiContent',
     },
   ],
+  examples: {
+    description:
+      'Learn how to access customer information in customer detail contexts.',
+    examples: [
+      {
+        codeblock: generateJsxCodeBlockForCustomerApi(
+          'Display the customer ID',
+          'id',
+        ),
+        description:
+          'Access the unique identifier of the current customer in a customer detail context. This example shows how to use `shopify.customer.id` to retrieve the customer ID. This can be used for fetching additional customer data, implementing loyalty features, or building personalized customer experiences.',
+      },
+    ],
+  },
+  category: 'Target APIs',
+  subCategory: 'Contextual APIs',
+  related: [],
   subSections: [
     {
       type: 'Generic',
@@ -39,23 +56,6 @@ Customer data reflects the current POS session and may not include real-time upd
 `,
     },
   ],
-  examples: {
-    description:
-      'Learn how to access customer information in customer detail contexts.',
-    examples: [
-      {
-        codeblock: generateJsxCodeBlockForCustomerApi(
-          'Display the customer ID',
-          'id',
-        ),
-        description:
-          'Access the unique identifier of the current customer in a customer detail context. This example shows how to use `shopify.customer.id` to retrieve the customer ID. This can be used for fetching additional customer data, implementing loyalty features, or building personalized customer experiences.',
-      },
-    ],
-  },
-  category: 'Target APIs',
-  subCategory: 'Contextual APIs',
-  related: [],
 };
 
 export default data;

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/draft-order-api.doc.ts

@@ -33,6 +33,14 @@ const data: ReferenceEntityTemplateSchema = {
         description:
           'Access the unique identifier of the current draft order in a draft order detail context. This example shows how to use `shopify.draftOrder.id` to retrieve the draft order ID. This can be used for fetching additional order data, implementing custom workflows, or building draft order-specific features.',
       },
+      {
+        codeblock: generateJsxCodeBlockForDraftOrderApi(
+          "Retrieve a draft order's name, ID, and associated customer ID",
+          'draft-order-details',
+        ),
+        description:
+          'Access multiple properties from the draft order object including name, ID, and customer information. This example demonstrates using `shopify.draftOrder` to retrieve comprehensive draft order details. This enables building contextual interfaces and implementing order-specific workflows.',
+      },
     ],
   },
   category: 'Target APIs',

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/order-api.doc.ts

@@ -58,6 +58,8 @@ Order data reflects the current POS session and may not include real-time update
           "Retrieve an order's name, ID, and associated customer ID",
           'order-details',
         ),
+        description:
+          'Access multiple order properties including the order name and customer ID. This example demonstrates accessing `shopify.order.id`, `shopify.order.name`, and `shopify.order.customerId` to display comprehensive order information. Use this pattern for order management workflows and customer service features.',
       },
     ],
   },

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/pinpad-api.doc.ts

@@ -60,6 +60,8 @@ const data: ReferenceEntityTemplateSchema = {
           'Configure PinPad options and handle dismissal',
           'validation-with-options',
         ),
+        description:
+          'Configure PIN pad options including PIN length requirements, masking, and custom labels. This example shows how to use `showPinPad()` with options like `minPinLength`, `maxPinLength`, `masked`, `title`, and `onDismissed` callback. This creates a fully configured PIN entry experience with proper validation and dismissal handling.',
       },
     ],
   },

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/product-api.doc.ts

@@ -36,6 +36,8 @@ const data: ReferenceEntityTemplateSchema = {
           'Retrieve product and product variant IDs',
           'product-variant',
         ),
+        description:
+          'Access both product and variant identifiers to implement variant-specific functionality. This example shows how to retrieve `shopify.product.id` and `shopify.product.variantId` together. Use this pattern for variant-aware features like inventory checks, variant-specific pricing, or detailed product information displays.',
       },
     ],
   },

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/scanner-api.doc.ts

@@ -60,6 +60,8 @@ const data: ReferenceEntityTemplateSchema = {
           'Subscribe to scanner data events and track scanning history',
           'scanner-data-subscribe',
         ),
+        description:
+          'Subscribe to real-time scan events and maintain a history of scanned items. This example demonstrates using `shopify.scanner.scannerData.current.subscribe()` to capture scan data, source information, and timestamps. Use this pattern for scan logging, bulk scanning workflows, or scan history review.',
       },
     ],
   },

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/session-api.doc.ts

@@ -59,6 +59,8 @@ const data: ReferenceEntityTemplateSchema = {
           'Access properties associated with the current session',
           'current-session',
         ),
+        description:
+          'Access comprehensive session information including shop details, user data, and location information. This example shows how to use `shopify.session.currentSession` to retrieve shop ID, domain, currency, user ID, location ID, staff member ID, and POS version. Use this data to build location-aware features and personalized experiences.',
       },
     ],
   },

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/toast-api.doc.ts

@@ -59,6 +59,8 @@ const data: ReferenceEntityTemplateSchema = {
           'Display a toast notification for a custom duration',
           'show-with-duration',
         ),
+        description:
+          'Configure custom display durations for toast notifications to match message importance and length. This example demonstrates using the `duration` option with `shopify.toast.show()` to control how long notifications remain visible. Use shorter durations for quick confirmations and longer durations for messages that require more reading time.',
       },
     ],
   },