chore(oas): [12/n] improve oas schemas (#9200)

- improve OAS schemas [12/n] - Support ignoring properties in type if it has the `@ignore` jsdoc tag.
2024-09-19 14:25:16 +00:00
parent 89928dfdf3
commit 4923a6e823
20 changed files with 287 additions and 149 deletions
@@ -1,25 +1,22 @@
 /**
 * @schema AdminRuleValueOption
 * type: object
- * description: The value's values.
+ * description: The details of a potential rule value.
 * x-schemaName: AdminRuleValueOption
 * required:
- *   - id
 *   - value
 *   - label
 * properties:
- *   id:
- *     type: string
- *     title: id
- *     description: The value's ID.
 *   value:
 *     type: string
 *     title: value
- *     description: The value's details.
+ *     description: The rule value's value.
+ *     example: "reg_123"
 *   label:
 *     type: string
 *     title: label
- *     description: The value's label.
+ *     description: The rule value's label.
+ *     example: "Europe Region"
 * 
 */