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

Improve OAS schemas [17/n]
2024-09-26 13:07:07 +00:00
parent 39a6780815
commit c5bf22f3f4
20 changed files with 679 additions and 205 deletions
@@ -1,8 +1,41 @@
 /**
 * @schema BaseRefund
 * type: object
- * description: The refund's refunds.
+ * description: The refund's details.
 * x-schemaName: BaseRefund
+ * required:
+ *   - id
+ *   - amount
+ *   - created_at
+ *   - payment
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The refund's ID.
+ *   amount:
+ *     type: number
+ *     title: amount
+ *     description: The refund's amount.
+ *   refund_reason_id:
+ *     type: string
+ *     title: refund_reason_id
+ *     description: The ID of the refund reason.
+ *   note:
+ *     type: string
+ *     title: note
+ *     description: More details about the refund.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The date the refund was created.
+ *   created_by:
+ *     type: string
+ *     title: created_by
+ *     description: The ID of the user that created the refund.
+ *   payment:
+ *     $ref: "#/components/schemas/BasePayment"
 * 
 */