chore(oas): [17/n] improve OAS schemas (#9284)

Improve OAS schemas [17/n]
This commit is contained in:
Shahed Nasser
2024-09-26 13:07:07 +00:00
committed by GitHub
parent 39a6780815
commit c5bf22f3f4
20 changed files with 679 additions and 205 deletions
@@ -1,7 +1,7 @@
/**
* @schema BaseOrderSummary
* type: object
* description: The order's summary.
* description: The order's summary details.
* x-schemaName: BaseOrderSummary
* required:
* - total
@@ -23,35 +23,35 @@
* total:
* type: number
* title: total
* description: The summary's total.
* description: The order's total including taxes and promotions.
* subtotal:
* type: number
* title: subtotal
* description: The summary's subtotal.
* description: The order's total excluding taxes, including promotions.
* total_tax:
* type: number
* title: total_tax
* description: The summary's total tax.
* description: The order's total taxes.
* ordered_total:
* type: number
* title: ordered_total
* description: The summary's ordered total.
* description: The order's total when it was placed.
* fulfilled_total:
* type: number
* title: fulfilled_total
* description: The summary's fulfilled total.
* description: The total of the fulfilled items of the order.
* returned_total:
* type: number
* title: returned_total
* description: The summary's returned total.
* description: The total of the order's returned items.
* return_request_total:
* type: number
* title: return_request_total
* description: The summary's return request total.
* description: The total of the items requested to be returned.
* write_off_total:
* type: number
* title: write_off_total
* description: The summary's write off total.
* description: The total of the items removed from the order.
* projected_total:
* type: number
* title: projected_total
@@ -75,11 +75,11 @@
* paid_total:
* type: number
* title: paid_total
* description: The summary's paid total.
* description: The total amount paid.
* refunded_total:
* type: number
* title: refunded_total
* description: The summary's refunded total.
* description: The total amount refunded.
*
*/