- improve OAS schemas [12/n] - Support ignoring properties in type if it has the `@ignore` jsdoc tag.
65 lines
1.6 KiB
TypeScript
65 lines
1.6 KiB
TypeScript
/**
|
|
* @schema AdminShippingOptionRule
|
|
* type: object
|
|
* description: The shipping option rule's details.
|
|
* x-schemaName: AdminShippingOptionRule
|
|
* required:
|
|
* - id
|
|
* - attribute
|
|
* - operator
|
|
* - value
|
|
* - shipping_option_id
|
|
* - created_at
|
|
* - updated_at
|
|
* - deleted_at
|
|
* properties:
|
|
* id:
|
|
* type: string
|
|
* title: id
|
|
* description: The shipping option rule's ID.
|
|
* attribute:
|
|
* type: string
|
|
* title: attribute
|
|
* description: The shipping option rule's attribute.
|
|
* example: is_return
|
|
* operator:
|
|
* type: string
|
|
* title: operator
|
|
* description: The shipping option rule's operator.
|
|
* example: eq
|
|
* value:
|
|
* oneOf:
|
|
* - type: string
|
|
* title: value
|
|
* description: The rule's value.
|
|
* example: '"true"'
|
|
* - type: array
|
|
* description: The rule's values.
|
|
* items:
|
|
* type: string
|
|
* title: value
|
|
* description: A rule's value
|
|
* example: '"true"'
|
|
* shipping_option_id:
|
|
* type: string
|
|
* title: 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 date the shipping option rule was created.
|
|
* updated_at:
|
|
* type: string
|
|
* format: date-time
|
|
* title: updated_at
|
|
* description: The date the shipping option rule was updated.
|
|
* deleted_at:
|
|
* type: string
|
|
* format: date-time
|
|
* title: deleted_at
|
|
* description: The date the shipping option rule was deleted.
|
|
*
|
|
*/
|
|
|