chore(oas): [14/n] improve OAS schemas (#9202)
* chore(oas): [14/n] improve OAS schemas * fix description of required_quantity
This commit is contained in:
1 parent
d6ce0688db
commit
426c39c04b
20 files changed
+133
-281
No files matched your search
@@ -1,23 +1,23 @@
|
||||
/**
|
||||
* @schema AdminUpdateTaxRate
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* description: The properties to update in the tax rate.
|
||||
* x-schemaName: AdminUpdateTaxRate
|
||||
* properties:
|
||||
* rate:
|
||||
* type: number
|
||||
* title: rate
|
||||
* description: The tax rate's rate.
|
||||
* description: The rate to charge.
|
||||
* code:
|
||||
* type: string
|
||||
* title: code
|
||||
* description: The tax rate's code.
|
||||
* description: The code that the tax rate is identified by.
|
||||
* rules:
|
||||
* type: array
|
||||
* description: The tax rate's rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The rule's rules.
|
||||
* description: A tax rate rule.
|
||||
* required:
|
||||
* - reference
|
||||
* - reference_id
|
||||
@@ -25,11 +25,13 @@
|
||||
* reference:
|
||||
* type: string
|
||||
* title: reference
|
||||
* description: The rule's reference.
|
||||
* description: The name of the table this rule references.
|
||||
* example: product_type
|
||||
* reference_id:
|
||||
* type: string
|
||||
* title: reference_id
|
||||
* description: The rule's reference id.
|
||||
* description: The ID of the record in the table that the rule references.
|
||||
* example: ptyp_123
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
@@ -37,14 +39,16 @@
|
||||
* is_default:
|
||||
* type: boolean
|
||||
* title: is_default
|
||||
* description: The tax rate's is default.
|
||||
* description: Whether the tax rate is the default in the store.
|
||||
* is_combinable:
|
||||
* type: boolean
|
||||
* title: is_combinable
|
||||
* description: The 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 tax rate's metadata.
|
||||
* description: The tax rate's metadata, can hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
Reference in new issue
Block a user