4923a6e823
- improve OAS schemas [12/n] - Support ignoring properties in type if it has the `@ignore` jsdoc tag.
80 lines
2.0 KiB
TypeScript
80 lines
2.0 KiB
TypeScript
/**
|
|
* @schema AdminShippingOptionPrice
|
|
* type: object
|
|
* description: The details of the shipping option's price.
|
|
* x-schemaName: AdminShippingOptionPrice
|
|
* required:
|
|
* - price_rules
|
|
* - rules_count
|
|
* - id
|
|
* - title
|
|
* - currency_code
|
|
* - amount
|
|
* - raw_amount
|
|
* - min_quantity
|
|
* - max_quantity
|
|
* - price_set_id
|
|
* - created_at
|
|
* - updated_at
|
|
* - deleted_at
|
|
* properties:
|
|
* price_rules:
|
|
* type: array
|
|
* description: The price's rules.
|
|
* items:
|
|
* $ref: "#/components/schemas/AdminShippingOptionPriceRule"
|
|
* rules_count:
|
|
* type: number
|
|
* title: rules_count
|
|
* description: The number of rules the price has.
|
|
* id:
|
|
* type: string
|
|
* title: id
|
|
* description: The price's ID.
|
|
* title:
|
|
* type: string
|
|
* title: title
|
|
* description: The price's title.
|
|
* currency_code:
|
|
* type: string
|
|
* title: currency_code
|
|
* description: The price's currency code.
|
|
* example: usd
|
|
* amount:
|
|
* type: number
|
|
* title: amount
|
|
* description: The price's amount.
|
|
* raw_amount:
|
|
* type: object
|
|
* description: The price's raw amount.
|
|
* min_quantity:
|
|
* type: number
|
|
* title: min_quantity
|
|
* description: The minimum quantity required in the cart for this price to apply.
|
|
* max_quantity:
|
|
* type: number
|
|
* title: max_quantity
|
|
* description: The maximum quantity that the cart's items must not surpass for this price to apply.
|
|
* price_set_id:
|
|
* type: string
|
|
* title: price_set_id
|
|
* description: The ID of the price set this price belongs to.
|
|
* created_at:
|
|
* type: string
|
|
* format: date-time
|
|
* title: created_at
|
|
* description: The date the price was created.
|
|
* updated_at:
|
|
* type: string
|
|
* format: date-time
|
|
* title: updated_at
|
|
* description: The date the price was updated.
|
|
* deleted_at:
|
|
* type: string
|
|
* format: date-time
|
|
* title: deleted_at
|
|
* description: The date the price was deleted.
|
|
*
|
|
*/
|
|
|