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

Improve OAS schemas [17/n]
This commit is contained in:
Shahed Nasser
2024-09-26 16:07:07 +03:00
committed by GitHub
parent 39a6780815
commit c5bf22f3f4
20 changed files with 679 additions and 205 deletions

View File

@@ -1,7 +1,7 @@
/**
* @schema BaseOrderTransaction
* type: object
* description: The transaction's transactions.
* description: An order transaction's details.
* x-schemaName: BaseOrderTransaction
* required:
* - id
@@ -21,7 +21,7 @@
* order_id:
* type: string
* title: order_id
* description: The transaction's order id.
* description: The ID of the order this transaction belongs to.
* amount:
* type: number
* title: amount
@@ -30,27 +30,31 @@
* type: string
* title: currency_code
* description: The transaction's currency code.
* example: usd
* reference:
* type: string
* title: reference
* description: The transaction's reference.
* description: The name of a table that this transaction references. If this transaction is for captured payment, its value is `capture`. If this transaction is for refunded payment, its value is `refund`.
* enum:
* - capture
* - refund
* reference_id:
* type: string
* title: reference_id
* description: The transaction's reference id.
* description: The ID of the referenced record in the referenced table.
* metadata:
* type: object
* description: The transaction's metadata.
* description: The transaction's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The transaction's created at.
* description: The date that the transaction was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The transaction's updated at.
* description: The date that the transaction was updated.
*
*/