oas: [3/n] improve oas schemas (#9042)

Improve oas schemas [3/n]
This commit is contained in:
Shahed Nasser
2024-09-07 06:16:00 +00:00
committed by GitHub
parent a7180e29b8
commit 4b8d9cc735
20 changed files with 285 additions and 97 deletions
@@ -1,7 +1,7 @@
/**
* @schema AdminCreateTaxRegion
* type: object
* description: SUMMARY
* description: The tax region's details.
* x-schemaName: AdminCreateTaxRegion
* required:
* - country_code
@@ -10,6 +10,7 @@
* type: string
* title: country_code
* description: The tax region's country code.
* example: us
* province_code:
* type: string
* title: province_code
@@ -17,7 +18,7 @@
* parent_id:
* type: string
* title: parent_id
* description: The tax region's parent id.
* description: The ID of the parent tax region.
* default_tax_rate:
* type: object
* description: The tax region's default tax rate.
@@ -27,25 +28,28 @@
* rate:
* type: number
* title: rate
* description: The default tax rate's rate.
* description: The rate to charge.
* example: 10
* code:
* type: string
* title: code
* description: The default tax rate's code.
* description: The code the tax rate is identified by
* name:
* type: string
* title: name
* description: The default tax rate's name.
* example: VAT
* is_combinable:
* type: boolean
* title: is_combinable
* description: The default tax rate's is combinable.
* description: Whether the tax rate should be combined with parent rates.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* metadata:
* type: object
* description: The default tax rate's metadata.
* description: The default tax rate's metadata, used to store custom key-value pairs.
* metadata:
* type: object
* description: The tax region's metadata.
* description: The tax region's metadata, used to store custom key-value pairs.
*
*/