oas: [2/n] Improve admin OAS

medusajs · Aug 29, 2024 · 4adcbf5 · 4adcbf5
1 parent 70f2290
commit 4adcbf5
Show file tree

Hide file tree

Showing 20 changed files with 101 additions and 70 deletions.
diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts
@@ -1,8 +1,8 @@
 /**
  * @oas [delete] /admin/order-edits/{id}
  * operationId: DeleteOrderEditsId
- * summary: Delete a Order Edit
- * description: Delete a order edit.
+ * summary: Cancel Order Edit
+ * description: Cancel an order edit.
  * x-authenticated: true
  * parameters:
  *   - name: id
@@ -93,14 +93,12 @@
  *             object:
  *               type: string
  *               title: object
- *               description: The order edit's object.
+ *               description: The name of the deleted object.
+ *               default: "order-edit"
  *             deleted:
  *               type: boolean
  *               title: deleted
- *               description: The order edit's deleted.
- *             parent:
- *               type: object
- *               description: The order edit's parent.
+ *               description: Whether the order edit was deleted.
  *   "400":
  *     $ref: "#/components/responses/400_error"
  *   "401":

diff --git a/.../generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts b/.../generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts
@@ -1,9 +1,14 @@
 /**
  * @oas [delete] /admin/order-edits/{id}/items/{action_id}
  * operationId: DeleteOrderEditsIdItemsAction_id
- * summary: Remove Items from Order Edit
- * description: Remove a list of items from a order edit. This doesn't delete the
- *   Item, only the association between the Item and the order edit.
+ * summary: Remove Item from Order Edit
+ * x-sidebar-summary: Remove Item
+ * description: >
+ *   Remove an added item in the order edit by the ID of the item's `ITEM_ADD` action.
+ * 
+ * 
+ *   Every item has an `actions` property, whose value is an array of actions. You can check the action's
+ *   name using its `action` property, and use the value of the `id` property.
  * x-authenticated: true
  * parameters:
  *   - name: id
@@ -14,7 +19,7 @@
  *       type: string
  *   - name: action_id
  *     in: path
- *     description: The order edit's action id.
+ *     description: The ID of the new item's `ITEM_ADD` action.
  *     required: true
  *     schema:
  *       type: string

diff --git a/.../oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts b/.../oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts
@@ -1,10 +1,14 @@
 /**
  * @oas [delete] /admin/order-edits/{id}/shipping-method/{action_id}
  * operationId: DeleteOrderEditsIdShippingMethodAction_id
- * summary: Remove Shipping Methods from Order Edit
- * description: Remove a list of shipping methods from a order edit. This doesn't
- *   delete the Shipping Method, only the association between the Shipping Method
- *   and the order edit.
+ * summary: Remove Shipping Method from Order Edit
+ * x-sidebar-summary: Remove Shipping Method
+ * description: >
+ *   Remove a shipping method in the order edit by the ID of the method's `SHIPPING_ADD` action.
+ * 
+ * 
+ *   Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's
+ *   name using its `action` property, and use the value of the `id` property.
  * x-authenticated: true
  * parameters:
  *   - name: id
@@ -15,7 +19,7 @@
  *       type: string
  *   - name: action_id
  *     in: path
- *     description: The order edit's action id.
+ *     description: The ID of the shipping method's `SHIPPING_ADD` action.
  *     required: true
  *     schema:
  *       type: string

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts
@@ -93,14 +93,12 @@
  *             object:
  *               type: string
  *               title: object
- *               description: The payment collection's object.
+ *               description: The name of the deleted object.
+ *               default: "payment-collection"
  *             deleted:
  *               type: boolean
  *               title: deleted
- *               description: The payment collection's deleted.
- *             parent:
- *               type: object
- *               description: The payment collection's parent.
+ *               description: Whether the payment collection was deleted.
  *   "400":
  *     $ref: "#/components/responses/400_error"
  *   "401":

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts
@@ -2,7 +2,7 @@
  * @oas [delete] /admin/product-categories/{id}
  * operationId: DeleteProductCategoriesId
  * summary: Delete a Product Category
- * description: Delete a product category.
+ * description: Delete a product category. This doesn't deleted products in that category.
  * x-authenticated: true
  * parameters:
  *   - name: id

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts
@@ -2,7 +2,7 @@
  * @oas [delete] /admin/product-tags/{id}
  * operationId: DeleteProductTagsId
  * summary: Delete a Product Tag
- * description: Delete a product tag.
+ * description: Delete a product tag. This doesn't delete products using the tag.
  * x-authenticated: true
  * parameters:
  *   - name: id

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts
@@ -2,7 +2,7 @@
  * @oas [delete] /admin/product-types/{id}
  * operationId: DeleteProductTypesId
  * summary: Delete a Product Type
- * description: Delete a product type.
+ * description: Delete a product type. This doesn't delete products of this type.
  * x-authenticated: true
  * parameters:
  *   - name: id

diff --git a/...s/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts b/...s/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts
@@ -1,9 +1,13 @@
 /**
  * @oas [delete] /admin/products/{id}/options/{option_id}
  * operationId: DeleteProductsIdOptionsOption_id
- * summary: Remove Options from Product
- * description: Remove a list of options from a product. This doesn't delete the
- *   Option, only the association between the Option and the product.
+ * summary: Delete an Option from Product
+ * x-sidebar-summary: Delete Option
+ * description: >
+ *   Delete an option from a product.
+ * 
+ * 
+ *   Values of this option in the product's variants are removed.
  * x-authenticated: true
  * parameters:
  *   - name: id
@@ -14,7 +18,7 @@
  *       type: string
  *   - name: option_id
  *     in: path
- *     description: The product's option id.
+ *     description: The product option's ID.
  *     required: true
  *     schema:
  *       type: string

diff --git a/...generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts b/...generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts
@@ -1,9 +1,9 @@
 /**
  * @oas [delete] /admin/products/{id}/variants/{variant_id}
  * operationId: DeleteProductsIdVariantsVariant_id
- * summary: Remove Variants from Product
- * description: Remove a list of variants from a product. This doesn't delete the
- *   Variant, only the association between the Variant and the product.
+ * summary: Delete Product Variant
+ * x-sidebar-summary: Delete Variant
+ * description: Delete a variant of a product.
  * x-authenticated: true
  * parameters:
  *   - name: id
@@ -14,7 +14,7 @@
  *       type: string
  *   - name: variant_id
  *     in: path
- *     description: The product's variant id.
+ *     description: The product variant's ID.
  *     required: true
  *     schema:
  *       type: string

diff --git a/...n/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/...n/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts
@@ -1,10 +1,9 @@
 /**
  * @oas [delete] /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}
  * operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id
- * summary: Remove Inventory Items from Product
- * description: Remove a list of inventory items from a product. This doesn't
- *   delete the Inventory Item, only the association between the Inventory Item and
- *   the product.
+ * summary: Remove Inventory Item Association with Product Variant
+ * x-sidebar-summary: Remove Inventory Item
+ * description: Remove the association between an inventory item and its product variant.
  * x-authenticated: true
  * parameters:
  *   - name: id
@@ -15,13 +14,13 @@
  *       type: string
  *   - name: variant_id
  *     in: path
- *     description: The product's variant id.
+ *     description: The products variant's ID.
  *     required: true
  *     schema:
  *       type: string
  *   - name: inventory_item_id
  *     in: path
- *     description: The product's inventory item id.
+ *     description: The inventory item's ID.
  *     required: true
  *     schema:
  *       type: string

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts
@@ -93,11 +93,12 @@
  *             object:
  *               type: string
  *               title: object
- *               description: The promotion's object.
+ *               description: The name of the deleted object.
+ *               default: "promotion"
  *             deleted:
  *               type: boolean
  *               title: deleted
- *               description: The promotion's deleted.
+ *               description: Whether the promotion was deleted.
  *             parent:
  *               type: object
  *               description: The promotion's parent.

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts
@@ -93,11 +93,12 @@
  *             object:
  *               type: string
  *               title: object
- *               description: The refund reason's object.
+ *               description: The name of the deleted object.
+ *               default: "refund_reason"
  *             deleted:
  *               type: boolean
  *               title: deleted
- *               description: The refund reason's deleted.
+ *               description: Whether the refund reason was deleted.
  *             parent:
  *               type: object
  *               description: The refund reason's parent.

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts
@@ -93,11 +93,12 @@
  *             object:
  *               type: string
  *               title: object
- *               description: The region's object.
+ *               description: The name of the deleted object.
+ *               default: "region"
  *             deleted:
  *               type: boolean
  *               title: deleted
- *               description: The region's deleted.
+ *               description: Whether the region was deleted.
  *             parent:
  *               type: object
  *               description: The region's parent.

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts
@@ -93,11 +93,12 @@
  *             object:
  *               type: string
  *               title: object
- *               description: The reservation's object.
+ *               description: The name of the deleted object.
+ *               default: "reservation"
  *             deleted:
  *               type: boolean
  *               title: deleted
- *               description: The reservation's deleted.
+ *               description: Whether the reservation was deleted.
  *             parent:
  *               type: object
  *               description: The reservation's parent.

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts
@@ -93,11 +93,12 @@
  *             object:
  *               type: string
  *               title: object
- *               description: The return reason's object.
+ *               description: The name of the deleted object.
+ *               default: "return_reason"
  *             deleted:
  *               type: boolean
  *               title: deleted
- *               description: The return reason's deleted.
+ *               description: Whether the return reason was deleted.
  *             parent:
  *               type: object
  *               description: The return reason's parent.

diff --git a/...erated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts b/...erated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts
@@ -1,9 +1,15 @@
 /**
  * @oas [delete] /admin/returns/{id}/dismiss-items/{action_id}
  * operationId: DeleteReturnsIdDismissItemsAction_id
- * summary: Remove Dismiss Items from Return
- * description: Remove a list of dismiss items from a return. This doesn't delete
- *   the Dismiss Item, only the association between the Dismiss Item and the
+ * summary: Remove Damaged Item from Return
+ * x-sidebar-summary: Remove Damaged Item
+ * description: >
+ *   Remove a damaged item, whose quantity is to be dismissed, in the return by the ID of the 
+ *   item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
+ * 
+ * 
+ *   Every item has an `actions` property, whose value is an array of actions. You can check the action's
+ *   name using its `action` property, and use the value of the `id` property.
  *   return.
  * x-authenticated: true
  * parameters:
@@ -15,7 +21,7 @@
  *       type: string
  *   - name: action_id
  *     in: path
- *     description: The return's action id.
+ *     description: The ID of the damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
  *     required: true
  *     schema:
  *       type: string

diff --git a/...erated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts b/...erated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts
@@ -1,9 +1,15 @@
 /**
  * @oas [delete] /admin/returns/{id}/receive-items/{action_id}
  * operationId: DeleteReturnsIdReceiveItemsAction_id
- * summary: Remove Receive Items from Return
- * description: Remove a list of receive items from a return. This doesn't delete
- *   the Receive Item, only the association between the Receive Item and the
+ * summary: Remove a Received Item from Return
+ * x-sidebar-summary: Remove Received Item
+ * description: >
+ *   Remove an item marked as received in the return by the ID of the 
+ *   item's `RECEIVE_RETURN_ITEM` action.
+ * 
+ * 
+ *   Every item has an `actions` property, whose value is an array of actions. You can check the action's
+ *   name using its `action` property, and use the value of the `id` property.
  *   return.
  * x-authenticated: true
  * parameters:
@@ -15,7 +21,7 @@
  *       type: string
  *   - name: action_id
  *     in: path
- *     description: The return's action id.
+ *     description: The ID of the received item's `RECEIVE_RETURN_ITEM` action.
  *     required: true
  *     schema:
  *       type: string

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts
@@ -1,9 +1,8 @@
 /**
  * @oas [delete] /admin/returns/{id}/receive
  * operationId: DeleteReturnsIdReceive
- * summary: Remove Receives from Return
- * description: Remove a list of receives from a return. This doesn't delete the
- *   Receive, only the association between the Receive and the return.
+ * summary: Cancel Return Receival
+ * description: Cancel the receival process previously started, and hasn't been confirmed, of a return.
  * x-authenticated: true
  * parameters:
  *   - name: id
@@ -94,11 +93,12 @@
  *             object:
  *               type: string
  *               title: object
- *               description: The return's object.
+ *               description: The name of the returned object.
+ *               default: "return"
  *             deleted:
  *               type: boolean
  *               title: deleted
- *               description: The return's deleted.
+ *               description: Whether the return was deleted.
  *             parent:
  *               type: object
  *               description: The return's parent.

diff --git a/...erated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts b/...erated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts
@@ -1,9 +1,15 @@
 /**
  * @oas [delete] /admin/returns/{id}/request-items/{action_id}
  * operationId: DeleteReturnsIdRequestItemsAction_id
- * summary: Remove Request Items from Return
- * description: Remove a list of request items from a return. This doesn't delete
- *   the Request Item, only the association between the Request Item and the
+ * summary: Remove Item from Return
+ * x-sidebar-summary: Remove Item
+ * description: >
+ *   Remove an item in the return by the ID of the 
+ *   item's `RETURN_ITEM` action.
+ * 
+ * 
+ *   Every item has an `actions` property, whose value is an array of actions. You can check the action's
+ *   name using its `action` property, and use the value of the `id` property.
  *   return.
  * x-authenticated: true
  * parameters:
@@ -15,7 +21,7 @@
  *       type: string
  *   - name: action_id
  *     in: path
- *     description: The return's action id.
+ *     description: The ID of the item's `RETURN_ITEM` action.
  *     required: true
  *     schema:
  *       type: string