chore(oas): [8/n] improve oas schemas (#9163)

Improve OAS schemas [8/n]
This commit is contained in:
Shahed Nasser
2024-09-17 17:26:41 +00:00
committed by GitHub
parent cda5bbac78
commit 78eaed70e5
20 changed files with 95 additions and 85 deletions
@@ -1,7 +1,7 @@
/**
* @schema AdminPostExchangesShippingReqSchema
* type: object
* description: SUMMARY
* description: The outbound shipping method's details.
* x-schemaName: AdminPostExchangesShippingReqSchema
* required:
* - shipping_option_id
@@ -9,22 +9,22 @@
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The exchange's shipping option id.
* description: The ID of the associated shipping option.
* custom_amount:
* type: number
* title: custom_amount
* description: The exchange's custom amount.
* description: Set a custom amount for the shipping method.
* description:
* type: string
* title: description
* description: The exchange's description.
* description: The shipping method's description.
* internal_note:
* type: string
* title: internal_note
* description: The exchange's internal note.
* description: A note viewed by admin users only.
* metadata:
* type: object
* description: The exchange's metadata.
* description: The exchange's metadata, can hold custom key-value pairs.
*
*/