asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(oas): [20/n] improve oas schemas (#9337)

Browse Source 
Improve oas schemas [20/n]
This commit is contained in:
Shahed Nasser
2024-09-26 20:21:07 +03:00
committed by GitHub
parent ef15c60386
commit 229da19029
26 changed files with 104 additions and 652 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
www/utils/generated/oas-output/schemas/AdminProductImage.ts
View File

@@ -1,8 +0,0 @@
/**
* @schema AdminProductImage
* type: object
* description: The image's details.
* x-schemaName: AdminProductImage
*
*/

40
www/utils/generated/oas-output/schemas/RefundReason.ts
View File

@@ -1,40 +0,0 @@
/**
* @schema RefundReason
* type: object
* description: The refund's refund reason.
* x-schemaName: RefundReason
* required:
* - id
* - label
* - metadata
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The refund reason's ID.
* label:
* type: string
* title: label
* description: The refund reason's label.
* description:
* type: string
* title: description
* description: The refund reason's description.
* metadata:
* type: object
* description: The refund reason's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The refund reason's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The refund reason's updated at.
*
*/

113
www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts
View File

@@ -1,113 +0,0 @@
/**
* @schema StoreCartShippingMethod
* type: object
* description: A cart's shipping method.
* x-schemaName: StoreCartShippingMethod
* required:
* - id
* - cart_id
* - name
* - amount
* - is_tax_inclusive
* - created_at
* - updated_at
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* properties:
* id:
* type: string
* title: id
* description: The shipping method's ID.
* cart_id:
* type: string
* title: cart_id
* description: The ID of the cart this shipping method belongs to.
* name:
* type: string
* title: name
* description: The shipping method's name.
* description:
* type: string
* title: description
* description: The shipping method's description.
* amount:
* type: number
* title: amount
* description: The shipping method's amount.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: Whether the shipping method's amount is tax inclusive.
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The ID of the shipping option this method was created from.
* data:
* type: object
* description: The shipping method's data, useful for fulfillment handling by third-party services.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
* tax_lines:
* type: array
* description: The shipping method's tax lines.
* items:
* $ref: "#/components/schemas/BaseShippingMethodTaxLine"
* adjustments:
* type: array
* description: The shipping method's adjustments, such as applied promotions.
* items:
* $ref: "#/components/schemas/BaseShippingMethodAdjustment"
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the shipping method was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the shipping method was updated.
* original_total:
* type: number
* title: original_total
* description: The shipping method's total including taxes, excluding promotions.
* original_subtotal:
* type: number
* title: original_subtotal
* description: The shipping method's total excluding taxes, including promotions.
* original_tax_total:
* type: number
* title: original_tax_total
* description: The total taxes applied on the shipping method's amount including promotions.
* total:
* type: number
* title: total
* description: The shipping method's total amount including taxes and promotions.
* subtotal:
* type: number
* title: subtotal
* description: The shipping method's total amount excluding taxes, including promotions.
* tax_total:
* type: number
* title: tax_total
* description: The total taxes applied on the shipping method's amount including promotions.
* discount_total:
* type: number
* title: discount_total
* description: The total amount discounted.
* discount_tax_total:
* type: number
* title: discount_tax_total
* description: The taxes applied on the discounted amount.
*
*/

10
www/utils/generated/oas-output/schemas/StoreCollection.ts
View File

@@ -28,25 +28,25 @@
* type: string
* format: date-time
* title: created_at
* description: The collection's created at.
* description: The date the collection was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The collection's updated at.
* description: The date the collection was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The collection's deleted at.
* description: The date the collection was deleted.
* products:
* type: array
* description: The collection's products.
* items:
* $ref: "#/components/schemas/AdminProduct"
* $ref: "#/components/schemas/StoreProduct"
* metadata:
* type: object
* description: The collection's metadata.
* description: The collection's metadata, can hold custom key-value pairs.
*
*/

2
www/utils/generated/oas-output/schemas/StoreCollectionResponse.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCollectionResponse
* type: object
* description: SUMMARY
* description: The collection's details.
* x-schemaName: StoreCollectionResponse
* required:
* - collection

13
www/utils/generated/oas-output/schemas/StoreCreateCart.ts
View File

@@ -1,13 +1,13 @@
/**
* @schema StoreCreateCart
* type: object
* description: SUMMARY
* description: The details of the cart to be created.
* x-schemaName: StoreCreateCart
* properties:
* region_id:
* type: string
* title: region_id
* description: The cart's region id.
* description: The ID of the cart's region. This affects the prices and currency of the cart.
* shipping_address:
* $ref: "#/components/schemas/StoreCartAddress"
* billing_address:
@@ -15,12 +15,13 @@
* email:
* type: string
* title: email
* description: The cart's email.
* description: The email of the cart's customer.
* format: email
* currency_code:
* type: string
* title: currency_code
* description: The cart's currency code.
* description: The cart's currency code. If not provided, the region's currency is used. This affects prices in the cart, as well.
* example: usd
* items:
* type: array
* description: The cart's items.
@@ -29,10 +30,10 @@
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The cart's sales channel id.
* description: The ID of the sales channel that cart is created in. Only products available in that sales channel can be added to the cart. If not provided, the store's default sales channel is associated with the cart instead.
* metadata:
* type: object
* description: The cart's metadata.
* description: The cart's metadata, can hold custom key-value pairs.
*
*/

4
www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCreateCustomer
* type: object
* description: SUMMARY
* description: The details of the customer to create.
* x-schemaName: StoreCreateCustomer
* required:
* - email
@@ -29,7 +29,7 @@
* description: The customer's phone.
* metadata:
* type: object
* description: The customer's metadata.
* description: The customer's metadata, can hold custom key-value pairs.
*
*/

4
www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCreatePaymentCollection
* type: object
* description: SUMMARY
* description: The details of the payment collection to create.
* x-schemaName: StoreCreatePaymentCollection
* required:
* - cart_id
@@ -9,7 +9,7 @@
* cart_id:
* type: string
* title: cart_id
* description: The payment collection's cart id.
* description: The ID of the cart this payment collection is for.
*
*/

10
www/utils/generated/oas-output/schemas/StoreCreateReturn.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCreateReturn
* type: object
* description: SUMMARY
* description: The details of the return to create.
* x-schemaName: StoreCreateReturn
* required:
* - order_id
@@ -11,7 +11,7 @@
* order_id:
* type: string
* title: order_id
* description: The return's order id.
* description: The ID of the order this return is created for.
* items:
* type: array
* description: The return's items.
@@ -22,15 +22,15 @@
* note:
* type: string
* title: note
* description: The return's note.
* description: A note with more details about the return.
* receive_now:
* type: boolean
* title: receive_now
* description: The return's receive now.
* description: Whether to mark the return as received.
* location_id:
* type: string
* title: location_id
* description: The return's location id.
* description: The ID of the location that items are returned to.
*
*/

6
www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCreateReturnItem
* type: object
* description: The item's items.
* description: The details of the line item to create.
* x-schemaName: StoreCreateReturnItem
* required:
* - id
@@ -18,11 +18,11 @@
* reason_id:
* type: string
* title: reason_id
* description: The item's reason id.
* description: The ID of the associated return reason.
* note:
* type: string
* title: note
* description: The item's note.
* description: A note with more details about the returned item.
*
*/

6
www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCreateReturnShipping
* type: object
* description: The return's return shipping.
* description: The return's shipping details.
* x-schemaName: StoreCreateReturnShipping
* required:
* - option_id
@@ -9,11 +9,11 @@
* option_id:
* type: string
* title: option_id
* description: The return shipping's option id.
* description: The ID of the shipping option to use.
* price:
* type: number
* title: price
* description: The return shipping's price.
* description: The shipping's price.
*
*/

22
www/utils/generated/oas-output/schemas/StoreCurrency.ts
View File

@@ -19,6 +19,7 @@
* type: string
* title: code
* description: The currency's code.
* example: usd
* symbol:
* type: string
* title: symbol
@@ -39,36 +40,21 @@
* type: number
* title: rounding
* description: The currency's rounding.
* raw_rounding:
* type: object
* description: The currency's raw rounding.
* required:
* - value
* - precision
* properties:
* value:
* type: string
* title: value
* description: The raw rounding's value.
* precision:
* type: number
* title: precision
* description: The raw rounding's precision.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The currency's created at.
* description: The date the currency was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The currency's updated at.
* description: The date the currency was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The currency's deleted at.
* description: The date the currency was deleted.
*
*/

10
www/utils/generated/oas-output/schemas/StoreCurrencyListResponse.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCurrencyListResponse
* type: object
* description: SUMMARY
* description: The paginated list of currencies.
* x-schemaName: StoreCurrencyListResponse
* required:
* - limit
@@ -12,18 +12,18 @@
* limit:
* type: number
* title: limit
* description: The currency's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The currency's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The currency's count.
* description: The total count of items.
* currencies:
* type: array
* description: The currency's currencies.
* description: The list of currencies.
* items:
* $ref: "#/components/schemas/StoreCurrency"
*

2
www/utils/generated/oas-output/schemas/StoreCurrencyResponse.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCurrencyResponse
* type: object
* description: SUMMARY
* description: The currency's details.
* x-schemaName: StoreCurrencyResponse
* required:
* - currency

40
www/utils/generated/oas-output/schemas/StoreCustomer.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCustomer
* type: object
* description: The customer's parent.
* description: The customer's details.
* x-schemaName: StoreCustomer
* required:
* - id
@@ -16,63 +16,59 @@
* id:
* type: string
* title: id
* description: The parent's ID.
* description: The customer's ID.
* email:
* type: string
* title: email
* description: The parent's email.
* description: The customer's email.
* format: email
* default_billing_address_id:
* type: string
* title: default_billing_address_id
* description: The parent's default billing address id.
* description: The ID of the address used for billing by default.
* default_shipping_address_id:
* type: string
* title: default_shipping_address_id
* description: The parent's default shipping address id.
* description: The ID of the address used for shipping by default.
* company_name:
* type: string
* title: company_name
* description: The parent's company name.
* description: The customer's company name.
* first_name:
* type: string
* title: first_name
* description: The parent's first name.
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The parent's last name.
* description: The customer's last name.
* addresses:
* type: array
* description: The parent's addresses.
* description: The customer's addresses.
* items:
* $ref: "#/components/schemas/StoreCustomerAddress"
* phone:
* type: string
* title: phone
* description: The parent's phone.
* description: The customer's phone.
* metadata:
* type: object
* description: The parent's metadata.
* created_by:
* type: string
* title: created_by
* description: The parent's created by.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The parent's deleted at.
* description: The customer's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The parent's created at.
* description: The date the customer was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The parent's updated at.
* description: The date the customer was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the customer was deleted.
*
*/

21
www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCustomerAddress
* type: object
* description: The customer's address.
* description: The customer address's details
* x-schemaName: StoreCustomerAddress
* required:
* - id
@@ -30,19 +30,19 @@
* address_name:
* type: string
* title: address_name
* description: The address's address name.
* description: The address's name.
* is_default_shipping:
* type: boolean
* title: is_default_shipping
* description: The address's is default shipping.
* description: Whether the address is used for shipping by default.
* is_default_billing:
* type: boolean
* title: is_default_billing
* description: The address's is default billing.
* description: Whether the address is used for billing by default.
* customer_id:
* type: string
* title: customer_id
* description: The address's customer id.
* description: The ID of the customer the address belongs to.
* company:
* type: string
* title: company
@@ -58,11 +58,11 @@
* address_1:
* type: string
* title: address_1
* description: The address's address 1.
* description: The address's first line.
* address_2:
* type: string
* title: address_2
* description: The address's address 2.
* description: The address's second line.
* city:
* type: string
* title: city
@@ -71,6 +71,7 @@
* type: string
* title: country_code
* description: The address's country code.
* example: usd
* province:
* type: string
* title: province
@@ -85,17 +86,17 @@
* description: The address's phone.
* metadata:
* type: object
* description: The address's metadata.
* description: The address's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The address's created at.
* description: The date the address was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The address's updated at.
* description: The date the address was updated.
*
*/

10
www/utils/generated/oas-output/schemas/StoreCustomerAddressListResponse.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCustomerAddressListResponse
* type: object
* description: SUMMARY
* description: The paginated list of customer addresses.
* x-schemaName: StoreCustomerAddressListResponse
* required:
* - limit
@@ -12,18 +12,18 @@
* limit:
* type: number
* title: limit
* description: The customer's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The customer's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The customer's count.
* description: The total number of items.
* addresses:
* type: array
* description: The customer's addresses.
* description: The list of addresses.
* items:
* $ref: "#/components/schemas/StoreCustomerAddress"
*

2
www/utils/generated/oas-output/schemas/StoreCustomerAddressResponse.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCustomerAddressResponse
* type: object
* description: SUMMARY
* description: The address's details.
* x-schemaName: StoreCustomerAddressResponse
* required:
* - address

2
www/utils/generated/oas-output/schemas/StoreCustomerResponse.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreCustomerResponse
* type: object
* description: SUMMARY
* description: The customer's details.
* x-schemaName: StoreCustomerResponse
* required:
* - customer

64
www/utils/generated/oas-output/schemas/StoreOrder.ts
View File

@@ -1,7 +1,7 @@
/**
* @schema StoreOrder
* type: object
* description: The cart's order.
* description: The order's details.
* x-schemaName: StoreOrder
* required:
* - id
@@ -53,28 +53,29 @@
* region_id:
* type: string
* title: region_id
* description: The order's region id.
* description: The ID of the associated region.
* customer_id:
* type: string
* title: customer_id
* description: The order's customer id.
* description: The ID of the customer that placed the order.
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The order's sales channel id.
* description: The ID of the sales channel the order was placed in.
* email:
* type: string
* title: email
* description: The order's email.
* description: The email of the customer that placed the order.
* format: email
* currency_code:
* type: string
* title: currency_code
* description: The order's currency code.
* example: usd
* display_id:
* type: number
* title: display_id
* description: The order's display id.
* description: The order's display ID.
* shipping_address:
* $ref: "#/components/schemas/BaseOrderAddress"
* billing_address:
@@ -125,74 +126,69 @@
* - shipped
* - partially_delivered
* - delivered
* transactions:
* type: array
* description: The order's transactions.
* items:
* $ref: "#/components/schemas/BaseOrderTransaction"
* summary:
* $ref: "#/components/schemas/BaseOrderSummary"
* metadata:
* type: object
* description: The order's metadata.
* description: The order's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The order's created at.
* description: The date the order was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The order's updated at.
* description: The date the order was updated.
* original_item_total:
* type: number
* title: original_item_total
* description: The order's original item total.
* description: The order items' total including taxes, excluding promotions.
* original_item_subtotal:
* type: number
* title: original_item_subtotal
* description: The order's original item subtotal.
* description: The order items' total excluding taxes, including promotions.
* original_item_tax_total:
* type: number
* title: original_item_tax_total
* description: The order's original item tax total.
* description: The total taxes applied on the order items, excluding promotions.
* item_total:
* type: number
* title: item_total
* description: The order's item total.
* description: The order items' total including taxes and promotions.
* item_subtotal:
* type: number
* title: item_subtotal
* description: The order's item subtotal.
* description: The order items' total excluding taxes, including promotions.
* item_tax_total:
* type: number
* title: item_tax_total
* description: The order's item tax total.
* description: The total taxes applied on the order's items, including promotions.
* original_total:
* type: number
* title: original_total
* description: The order's original total.
* description: The order's total including taxes, excluding promotions.
* original_subtotal:
* type: number
* title: original_subtotal
* description: The order's original subtotal.
* description: The order's total excluding taxes, including promotions.
* original_tax_total:
* type: number
* title: original_tax_total
* description: The order's original tax total.
* description: The total taxes of the order excluding promotions.
* total:
* type: number
* title: total
* description: The order's total.
* description: The order's total including taxes and promotions.
* subtotal:
* type: number
* title: subtotal
* description: The order's subtotal.
* description: The order's total excluding taxes, including promotions.
* tax_total:
* type: number
* title: tax_total
* description: The order's tax total.
* description: The tax totals of the order including promotions.
* discount_total:
* type: number
* title: discount_total
@@ -200,7 +196,7 @@
* discount_tax_total:
* type: number
* title: discount_tax_total
* description: The order's discount tax total.
* description: The total taxes applied on the discounted amount.
* gift_card_total:
* type: number
* title: gift_card_total
@@ -208,31 +204,31 @@
* gift_card_tax_total:
* type: number
* title: gift_card_tax_total
* description: The order's gift card tax total.
* description: The total taxes applied on the gift card's amount.
* shipping_total:
* type: number
* title: shipping_total
* description: The order's shipping total.
* description: The order's shipping total including taxes and promotions.
* shipping_subtotal:
* type: number
* title: shipping_subtotal
* description: The order's shipping subtotal.
* description: The order's shipping total excluding taxes, including promotions.
* shipping_tax_total:
* type: number
* title: shipping_tax_total
* description: The order's shipping tax total.
* description: The total taxes of the order's shipping including promotions.
* original_shipping_total:
* type: number
* title: original_shipping_total
* description: The order's original shipping total.
* description: The order's shipping total including taxes, excluding promotions.
* original_shipping_subtotal:
* type: number
* title: original_shipping_subtotal
* description: The order's original shipping subtotal.
* description: The order's shipping total excluding taxes, including promotions.
* original_shipping_tax_total:
* type: number
* title: original_shipping_tax_total
* description: The order's original shipping tax total.
* description: The total taxes of the order's shipping excluding promotions.
*
*/

63
www/utils/generated/oas-output/schemas/StorePaymentSession.ts
View File

@@ -1,63 +0,0 @@
/**
* @schema StorePaymentSession
* type: object
* description: The payment session's details.
* x-schemaName: StorePaymentSession
* properties:
* id:
* type: string
* title: id
* description: The payment session's ID.
* amount:
* type: number
* title: amount
* description: The payment session's amount.
* currency_code:
* type: string
* title: currency_code
* description: The payment session's currency code.
* example: usd
* provider_id:
* type: string
* title: provider_id
* description: The ID of the payment provider processing this session.
* data:
* type: object
* description: The payment session's data, useful for the payment provider processing the payment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property
* context:
* type: object
* description: The context around the payment, such as the customer's details.
* example:
* customer:
* id: cus_123
* status:
* type: string
* description: The payment session's status.
* enum:
* - authorized
* - captured
* - canceled
* - pending
* - requires_more
* - error
* authorized_at:
* type: string
* title: authorized_at
* description: The date the payment session was authorized.
* format: date-time
* payment_collection:
* $ref: "#/components/schemas/StorePaymentCollection"
* payment:
* $ref: "#/components/schemas/BasePayment"
* required:
* - id
* - amount
* - currency_code
* - provider_id
* - data
* - status
*
*/

38
www/utils/generated/oas-output/schemas/StoreProductImage.ts
View File

@@ -1,38 +0,0 @@
/**
* @schema StoreProductImage
* type: object
* description: The image's details.
* x-schemaName: StoreProductImage
* properties:
* id:
* type: string
* title: id
* description: The image's ID.
* url:
* type: string
* title: url
* description: The image's URL.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the image was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the image was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the image was deleted.
* metadata:
* type: object
* description: The image's metadata, can hold custom key-value pairs.
* required:
* - id
* - url
*
*/

49
www/utils/generated/oas-output/schemas/StoreProductOption.ts
View File

@@ -1,49 +0,0 @@
/**
* @schema StoreProductOption
* type: object
* description: The product option's details.
* x-schemaName: StoreProductOption
* properties:
* id:
* type: string
* title: id
* description: The option's ID.
* title:
* type: string
* title: title
* description: The option's title.
* product:
* $ref: "#/components/schemas/StoreProduct"
* product_id:
* type: string
* title: product_id
* description: The option's product id.
* values:
* type: array
* description: The option's values.
* items:
* $ref: "#/components/schemas/StoreProductOptionValue"
* metadata:
* type: object
* description: The option's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The option's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The option's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The option's deleted at.
* required:
* - id
* - title
*
*/

44
www/utils/generated/oas-output/schemas/StoreProductOptionValue.ts
View File

@@ -1,44 +0,0 @@
/**
* @schema StoreProductOptionValue
* type: object
* description: The product option value's details.
* x-schemaName: StoreProductOptionValue
* required:
* - id
* - value
* properties:
* id:
* type: string
* title: id
* description: The value's ID.
* value:
* type: string
* title: value
* description: The value.
* option:
* $ref: "#/components/schemas/StoreProductOption"
* option_id:
* type: string
* title: option_id
* description: The ID of the option this value belongs to.
* metadata:
* type: object
* description: The value's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the value was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the value was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the value was deleted.
*
*/

40
www/utils/generated/oas-output/schemas/StoreProductTag.ts
View File

@@ -1,40 +0,0 @@
/**
* @schema StoreProductTag
* type: object
* description: The tag's tags.
* x-schemaName: StoreProductTag
* properties:
* id:
* type: string
* title: id
* description: The tag's ID.
* value:
* type: string
* title: value
* description: The tag's value.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The tag's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The tag's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The tag's deleted at.
* metadata:
* type: object
* description: The tag's metadata.
* required:
* - id
* - value
* - created_at
* - updated_at
*
*/

133
www/utils/generated/oas-output/schemas/StoreProductVariant.ts
View File

@@ -1,133 +0,0 @@
/**
* @schema StoreProductVariant
* type: object
* description: The variant's variants.
* x-schemaName: StoreProductVariant
* properties:
* options:
* type: array
* description: The variant's options.
* items:
* $ref: "#/components/schemas/StoreProductOptionValue"
* product:
* $ref: "#/components/schemas/StoreProduct"
* id:
* type: string
* title: id
* description: The variant's ID.
* metadata:
* type: object
* description: The variant's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The variant's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The variant's updated at.
* title:
* type: string
* title: title
* description: The variant's title.
* product_id:
* type: string
* title: product_id
* description: The variant's product id.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The variant's deleted at.
* width:
* type: number
* title: width
* description: The variant's width.
* weight:
* type: number
* title: weight
* description: The variant's weight.
* length:
* type: number
* title: length
* description: The variant's length.
* height:
* type: number
* title: height
* description: The variant's height.
* origin_country:
* type: string
* title: origin_country
* description: The variant's origin country.
* hs_code:
* type: string
* title: hs_code
* description: The variant's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The variant's mid code.
* material:
* type: string
* title: material
* description: The variant's material.
* sku:
* type: string
* title: sku
* description: The variant's sku.
* barcode:
* type: string
* title: barcode
* description: The variant's barcode.
* ean:
* type: string
* title: ean
* description: The variant's ean.
* upc:
* type: string
* title: upc
* description: The variant's upc.
* allow_backorder:
* oneOf:
* - {}
* - {}
* manage_inventory:
* oneOf:
* - {}
* - {}
* inventory_quantity:
* type: number
* title: inventory_quantity
* description: The variant's inventory quantity.
* variant_rank:
* type: number
* title: variant_rank
* description: The variant's variant rank.
* calculated_price:
* $ref: "#/components/schemas/BaseCalculatedPriceSet"
* required:
* - options
* - id
* - created_at
* - updated_at
* - title
* - deleted_at
* - width
* - weight
* - length
* - height
* - origin_country
* - hs_code
* - mid_code
* - material
* - sku
* - barcode
* - ean
* - upc
* - allow_backorder
* - manage_inventory
*
*/