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.
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-09-19 14:25:16 +00:00
1 parent 89928dfdf3
commit 4923a6e823
20 files changed
+287 -149

No files matched your search

@@ -1,7 +1,7 @@
/**
* @schema AdminShippingOptionRule
* type: object
* description: The updated's details.
* description: The shipping option rule's details.
* x-schemaName: AdminShippingOptionRule
* required:
* - id
@@ -16,45 +16,49 @@
* id:
* type: string
* title: id
* description: The updated's ID.
* description: The shipping option rule's ID.
* attribute:
* type: string
* title: attribute
* description: The updated's attribute.
* description: The shipping option rule's attribute.
* example: is_return
* operator:
* type: string
* title: operator
* description: The updated's operator.
* description: The shipping option rule's operator.
* example: eq
* value:
* oneOf:
* - type: string
* title: value
* description: The updated's value.
* description: The rule's value.
* example: '"true"'
* - type: array
* description: The updated's value.
* description: The rule's values.
* items:
* type: string
* title: value
* description: The value's details.
* description: A rule's value
* example: '"true"'
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The updated's shipping option id.
* description: The ID of the shipping option this rule is for.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The updated's created at.
* description: The date the shipping option rule was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The updated's updated at.
* description: The date the shipping option rule was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The updated's deleted at.
* description: The date the shipping option rule was deleted.
*
*/