docs: fix OAS generator + generate OAS (#11584)

This commit is contained in:
Shahed Nasser
2025-02-24 15:30:38 +02:00
committed by GitHub
parent 41f070be9a
commit be566ca6fb
44 changed files with 10904 additions and 8753 deletions

View File

@@ -2,49 +2,14 @@ type: object
description: The order's summary details.
x-schemaName: BaseOrderSummary
required:
- total
- subtotal
- total_tax
- ordered_total
- fulfilled_total
- returned_total
- return_request_total
- write_off_total
- pending_difference
- current_order_total
- original_order_total
- transaction_total
- paid_total
- refunded_total
- accounting_total
properties:
total:
type: number
title: total
description: The order's total including taxes and promotions.
subtotal:
type: number
title: subtotal
description: The order's total excluding taxes, including promotions.
total_tax:
type: number
title: total_tax
description: The order's total taxes.
ordered_total:
type: number
title: ordered_total
description: The order's total when it was placed.
fulfilled_total:
type: number
title: fulfilled_total
description: The total of the fulfilled items of the order.
returned_total:
type: number
title: returned_total
description: The total of the order's returned items.
return_request_total:
type: number
title: return_request_total
description: The total of the items requested to be returned.
write_off_total:
type: number
title: write_off_total
description: The total of the items removed from the order.
paid_total:
type: number
title: paid_total
@@ -53,3 +18,25 @@ properties:
type: number
title: refunded_total
description: The total amount refunded.
pending_difference:
type: number
title: pending_difference
description: >-
The difference pending to be processed. If negative, the customer needs a
refund. Otherwise, additional payment is required from the customer.
current_order_total:
type: number
title: current_order_total
description: The order's current total, could be the total after a change in the order.
original_order_total:
type: number
title: original_order_total
description: The order's original total.
transaction_total:
type: number
title: transaction_total
description: The total of the transactions made on the order.
accounting_total:
type: number
title: accounting_total
description: The order's total without the credit-line total.