Merge branch 'develop' into oas/improve-oas-schemas-21

medusajs · Sep 27, 2024 · 44ad480 · 44ad480
2 parents 3fe3068 + bd4d2fd
commit 44ad480
Show file tree

Hide file tree

Showing 39 changed files with 211 additions and 510 deletions.
diff --git a/www/utils/generated/oas-output/schemas/AdminProductImage.ts b/www/utils/generated/oas-output/schemas/AdminProductImage.ts
diff --git a/www/utils/generated/oas-output/schemas/RefundReason.ts b/www/utils/generated/oas-output/schemas/RefundReason.ts
diff --git a/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts b/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts
diff --git a/www/utils/generated/oas-output/schemas/StoreCollection.ts b/www/utils/generated/oas-output/schemas/StoreCollection.ts
@@ -28,25 +28,25 @@
  *     type: string
  *     format: date-time
  *     title: created_at
- *     description: The collection's created at.
+ *     description: The date the collection was created.
  *   updated_at:
  *     type: string
  *     format: date-time
  *     title: updated_at
- *     description: The collection's updated at.
+ *     description: The date the collection was updated.
  *   deleted_at:
  *     type: string
  *     format: date-time
  *     title: deleted_at
- *     description: The collection's deleted at.
+ *     description: The date the collection was deleted.
  *   products:
  *     type: array
  *     description: The collection's products.
  *     items:
- *       $ref: "#/components/schemas/AdminProduct"
+ *       $ref: "#/components/schemas/StoreProduct"
  *   metadata:
  *     type: object
- *     description: The collection's metadata.
+ *     description: The collection's metadata, can hold custom key-value pairs.
  * 
 */
 
diff --git a/www/utils/generated/oas-output/schemas/StoreCollectionResponse.ts b/www/utils/generated/oas-output/schemas/StoreCollectionResponse.ts
@@ -1,7 +1,7 @@
 /**
  * @schema StoreCollectionResponse
  * type: object
- * description: SUMMARY
+ * description: The collection's details.
  * x-schemaName: StoreCollectionResponse
  * required:
  *   - collection

diff --git a/www/utils/generated/oas-output/schemas/StoreCreateCart.ts b/www/utils/generated/oas-output/schemas/StoreCreateCart.ts
@@ -1,26 +1,27 @@
 /**
  * @schema StoreCreateCart
  * type: object
- * description: SUMMARY
+ * description: The details of the cart to be created.
  * x-schemaName: StoreCreateCart
  * properties:
  *   region_id:
  *     type: string
  *     title: region_id
- *     description: The cart's region id.
+ *     description: The ID of the cart's region. This affects the prices and currency of the cart.
  *   shipping_address:
  *     $ref: "#/components/schemas/StoreCartAddress"
  *   billing_address:
  *     $ref: "#/components/schemas/StoreCartAddress"
  *   email:
  *     type: string
  *     title: email
- *     description: The cart's email.
+ *     description: The email of the cart's customer.
  *     format: email
  *   currency_code:
  *     type: string
  *     title: currency_code
- *     description: The cart's currency code.
+ *     description: The cart's currency code. If not provided, the region's currency is used. This affects prices in the cart, as well.
+ *     example: usd
  *   items:
  *     type: array
  *     description: The cart's items.
@@ -29,10 +30,10 @@
  *   sales_channel_id:
  *     type: string
  *     title: sales_channel_id
- *     description: The cart's sales channel id.
+ *     description: The ID of the sales channel that cart is created in. Only products available in that sales channel can be added to the cart. If not provided, the store's default sales channel is associated with the cart instead.
  *   metadata:
  *     type: object
- *     description: The cart's metadata.
+ *     description: The cart's metadata, can hold custom key-value pairs.
  * 
 */
 
diff --git a/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts b/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts
@@ -1,7 +1,7 @@
 /**
  * @schema StoreCreateCustomer
  * type: object
- * description: SUMMARY
+ * description: The details of the customer to create.
  * x-schemaName: StoreCreateCustomer
  * required:
  *   - email
@@ -29,7 +29,7 @@
  *     description: The customer's phone.
  *   metadata:
  *     type: object
- *     description: The customer's metadata.
+ *     description: The customer's metadata, can hold custom key-value pairs.
  * 
 */
 
diff --git a/www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts b/www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts
@@ -1,15 +1,15 @@
 /**
  * @schema StoreCreatePaymentCollection
  * type: object
- * description: SUMMARY
+ * description: The details of the payment collection to create.
  * x-schemaName: StoreCreatePaymentCollection
  * required:
  *   - cart_id
  * properties:
  *   cart_id:
  *     type: string
  *     title: cart_id
- *     description: The payment collection's cart id.
+ *     description: The ID of the cart this payment collection is for.
  * 
 */
 
diff --git a/www/utils/generated/oas-output/schemas/StoreCreateReturn.ts b/www/utils/generated/oas-output/schemas/StoreCreateReturn.ts
@@ -1,7 +1,7 @@
 /**
  * @schema StoreCreateReturn
  * type: object
- * description: SUMMARY
+ * description: The details of the return to create.
  * x-schemaName: StoreCreateReturn
  * required:
  *   - order_id
@@ -11,7 +11,7 @@
  *   order_id:
  *     type: string
  *     title: order_id
- *     description: The return's order id.
+ *     description: The ID of the order this return is created for.
  *   items:
  *     type: array
  *     description: The return's items.
@@ -22,15 +22,15 @@
  *   note:
  *     type: string
  *     title: note
- *     description: The return's note.
+ *     description: A note with more details about the return.
  *   receive_now:
  *     type: boolean
  *     title: receive_now
- *     description: The return's receive now.
+ *     description: Whether to mark the return as received.
  *   location_id:
  *     type: string
  *     title: location_id
- *     description: The return's location id.
+ *     description: The ID of the location that items are returned to.
  * 
 */
 
diff --git a/www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts b/www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts
@@ -1,7 +1,7 @@
 /**
  * @schema StoreCreateReturnItem
  * type: object
- * description: The item's items.
+ * description: The details of the line item to create.
  * x-schemaName: StoreCreateReturnItem
  * required:
  *   - id
@@ -18,11 +18,11 @@
  *   reason_id:
  *     type: string
  *     title: reason_id
- *     description: The item's reason id.
+ *     description: The ID of the associated return reason.
  *   note:
  *     type: string
  *     title: note
- *     description: The item's note.
+ *     description: A note with more details about the returned item.
  * 
 */
 
diff --git a/www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts b/www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts
@@ -1,19 +1,19 @@
 /**
  * @schema StoreCreateReturnShipping
  * type: object
- * description: The return's return shipping.
+ * description: The return's shipping details.
  * x-schemaName: StoreCreateReturnShipping
  * required:
  *   - option_id
  * properties:
  *   option_id:
  *     type: string
  *     title: option_id
- *     description: The return shipping's option id.
+ *     description: The ID of the shipping option to use.
  *   price:
  *     type: number
  *     title: price
- *     description: The return shipping's price.
+ *     description: The shipping's price.
  * 
 */