oas: [3/n] improve oas schemas (#9042)

Improve oas schemas [3/n]
2024-09-07 06:16:00 +00:00
parent a7180e29b8
commit 4b8d9cc735
20 changed files with 285 additions and 97 deletions
@@ -1,7 +1,7 @@
 /**
 * @schema AdminCreateShippingOptionRule
 * type: object
- * description: The rule's rules.
+ * description: The details of the shipping option rule.
 * x-schemaName: AdminCreateShippingOptionRule
 * required:
 *   - operator
@@ -10,7 +10,7 @@
 * properties:
 *   operator:
 *     type: string
- *     description: The rule's operator.
+ *     description: The operator used to check whether a rule applies.
 *     enum:
 *       - gt
 *       - lt
@@ -23,18 +23,21 @@
 *   attribute:
 *     type: string
 *     title: attribute
- *     description: The rule's attribute.
+ *     description: The name of a property or table that the rule applies to.
+ *     example: customer_group
 *   value:
 *     oneOf:
 *       - type: string
 *         title: value
- *         description: The rule's value.
+ *         description: A value of the attribute that enables this rule.
+ *         example: cusgroup_123
 *       - type: array
- *         description: The rule's value.
+ *         description: Values of the attribute that enable this rule.
 *         items:
 *           type: string
 *           title: value
- *           description: The value's details.
+ *           description: A value of the attribute that enables this rule.
+ *           example: cusgroup_123
 * 
 */