chore(oas): [10/n] improve oas schemas (#9167)
* chore(oas): [10/n] improve oas schemas * fix validation error --------- Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
Oli Juhl
parent
230a16ac5c
commit
d6ce0688db
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* @schema AdminProductVariant
|
||||
* type: object
|
||||
* description: The product's parent.
|
||||
* description: The product variant's details.
|
||||
* x-schemaName: AdminProductVariant
|
||||
* required:
|
||||
* - prices
|
||||
@@ -28,84 +28,84 @@
|
||||
* properties:
|
||||
* prices:
|
||||
* type: array
|
||||
* description: The parent's prices.
|
||||
* description: The variant's prices.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPrice"
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The parent's ID.
|
||||
* description: The variant's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The parent's title.
|
||||
* description: The variant's title.
|
||||
* sku:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The parent's sku.
|
||||
* description: The variant's SKU.
|
||||
* barcode:
|
||||
* type: string
|
||||
* title: barcode
|
||||
* description: The parent's barcode.
|
||||
* description: The variant's barcode.
|
||||
* ean:
|
||||
* type: string
|
||||
* title: ean
|
||||
* description: The parent's ean.
|
||||
* description: The variant's EAN code.
|
||||
* upc:
|
||||
* type: string
|
||||
* title: upc
|
||||
* description: The parent's upc.
|
||||
* description: The variant's UPC.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: The parent's allow backorder.
|
||||
* description: Whether the variant can be ordered even if it's out of stock.
|
||||
* manage_inventory:
|
||||
* type: boolean
|
||||
* title: manage_inventory
|
||||
* description: The parent's manage inventory.
|
||||
* description: Whether the Medusa application manages the variant's inventory quantity and availablility. If disabled, the variant is always considered in stock.
|
||||
* inventory_quantity:
|
||||
* type: number
|
||||
* title: inventory_quantity
|
||||
* description: The parent's inventory quantity.
|
||||
* description: The variant's inventory quantity. This is only included if you pass in the `fields` query parameter a `+variants.inventory_quantity` parameter.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The parent's hs code.
|
||||
* description: The variant's HS code.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The parent's origin country.
|
||||
* description: The variant's origin country.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The parent's mid code.
|
||||
* description: The variant's MID code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The parent's material.
|
||||
* description: The variant's material.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The parent's weight.
|
||||
* description: The variant's weight.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The parent's length.
|
||||
* description: The variant's length.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The parent's height.
|
||||
* description: The variant's height.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The parent's width.
|
||||
* description: The variant's width.
|
||||
* variant_rank:
|
||||
* type: number
|
||||
* title: variant_rank
|
||||
* description: The parent's variant rank.
|
||||
* description: The variant's rank among its sibling variants.
|
||||
* options:
|
||||
* type: array
|
||||
* description: The parent's options.
|
||||
* description: The variant's option values.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseProductOptionValue"
|
||||
* product:
|
||||
@@ -113,27 +113,27 @@
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The parent's product id.
|
||||
* description: The ID of the product that the variant belongs to.
|
||||
* calculated_price:
|
||||
* $ref: "#/components/schemas/BaseCalculatedPriceSet"
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The parent's created at.
|
||||
* description: The date the variant was created.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The parent's updated at.
|
||||
* description: The date the variant was updated.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The parent's deleted at.
|
||||
* description: The date the variant was deleted.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The parent's metadata.
|
||||
* description: The variant's metadata, can hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user