chore(oas): [8/n] improve oas schemas (#9163)

Improve OAS schemas [8/n]
2024-09-17 17:26:41 +00:00
parent cda5bbac78
commit 78eaed70e5
20 changed files with 95 additions and 85 deletions
@@ -1,20 +1,20 @@
 /**
 * @schema AdminPostOrderEditsShippingActionReqSchema
 * type: object
- * description: SUMMARY
+ * description: The shipping method's details.
 * x-schemaName: AdminPostOrderEditsShippingActionReqSchema
 * properties:
 *   custom_amount:
 *     type: number
 *     title: custom_amount
- *     description: The order edit's custom amount.
+ *     description: Set a custom price for the shipping method.
 *   internal_note:
 *     type: string
 *     title: internal_note
- *     description: The order edit's internal note.
+ *     description: A note viewed only by admin users.
 *   metadata:
 *     type: object
- *     description: The order edit's metadata.
+ *     description: The order edit's metadata, can hold custom key-value pairs.
 * 
 */