chore(oas): [21/21] improve oas schemas (#9339)
* improve oas * more improvements * add missing descriptions --------- Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
Oli Juhl
parent
38778b37e2
commit
74b3385a65
@@ -1,38 +1,39 @@
|
||||
/**
|
||||
* @schema UpdateCartData
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* description: The details to update in a cart.
|
||||
* x-schemaName: UpdateCartData
|
||||
* properties:
|
||||
* region_id:
|
||||
* type: string
|
||||
* title: region_id
|
||||
* description: The cart's region id.
|
||||
* description: The ID of the associated region. This can affect the prices and currency code of the cart.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The cart's customer id.
|
||||
* description: The ID of the customer that the cart belongs to.
|
||||
* sales_channel_id:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The cart's sales channel id.
|
||||
* description: The ID of the associated sales channel. Only products available in this channel can be added to the cart.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The cart's email.
|
||||
* description: The email of the customer that the cart belongs to.
|
||||
* format: email
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The cart's currency code.
|
||||
* example: usd
|
||||
* shipping_address_id:
|
||||
* type: string
|
||||
* title: shipping_address_id
|
||||
* description: The cart's shipping address id.
|
||||
* description: The ID of the cart's shipping address.
|
||||
* billing_address_id:
|
||||
* type: string
|
||||
* title: billing_address_id
|
||||
* description: The cart's billing address id.
|
||||
* description: The ID of the cart's billing address.
|
||||
* billing_address:
|
||||
* oneOf:
|
||||
* - $ref: "#/components/schemas/CreateAddress"
|
||||
@@ -43,7 +44,7 @@
|
||||
* - $ref: "#/components/schemas/UpdateAddress"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The cart's metadata.
|
||||
* description: The cart's metadata, ca hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user