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

chore(docs): Updated API Reference (automated) (#10047)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-11-12 10:32:44 +00:00
committed by GitHub
parent c3a0123958
commit 9e40f34ba8
8 changed files with 441 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantRequest.yaml
View File

@@ -11,7 +11,7 @@ properties:
type: array
description: The product variants to update.
items:
$ref: ./AdminUpdateProductVariant.yaml
$ref: ./AdminBatchUpdateProductVariant.yaml
delete:
type: array
description: The product variants to delete.

87
www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProductVariant.yaml Normal file
View File

@@ -0,0 +1,87 @@
type: object
description: The properties to update of a product variant.
x-schemaName: AdminBatchUpdateProductVariant
properties:
title:
type: string
title: title
description: The product variant's title.
sku:
type: string
title: sku
description: The product variant's SKU.
ean:
type: string
title: ean
description: The product variant's EAN.
upc:
type: string
title: upc
description: The product variant's UPC.
barcode:
type: string
title: barcode
description: The product variant's barcode.
hs_code:
type: string
title: hs_code
description: The product variant's HS code.
mid_code:
type: string
title: mid_code
description: The product variant's MID code.
allow_backorder:
type: boolean
title: allow_backorder
description: Whether customers can order the variant even if it's not in stock.
manage_inventory:
type: boolean
title: manage_inventory
description: >-
Whether the Medusa application manages the variant's inventory. If
disabled, the product variant is always considered in stock.
variant_rank:
type: number
title: variant_rank
description: The product variant's rank among its siblings.
weight:
type: number
title: weight
description: The product variant's weight.
length:
type: number
title: length
description: The product variant's length.
height:
type: number
title: height
description: The product variant's height.
width:
type: number
title: width
description: The product variant's width.
origin_country:
type: string
title: origin_country
description: The product variant's origin country.
material:
type: string
title: material
description: The product variant's material.
metadata:
type: object
description: The product variant's metadata, can hold custom key-value pairs.
prices:
type: array
description: The product variant's prices.
items:
$ref: ./AdminCreateProductVariantPrice.yaml
options:
type: object
description: The product variant's options.
id:
type: string
title: id
description: The update's ID.
required:
- id

88
www/apps/api-reference/specs/admin/openapi.full.yaml
View File

@@ -43651,7 +43651,7 @@ components:
type: array
description: The product variants to update.
items:
$ref: '#/components/schemas/AdminUpdateProductVariant'
$ref: '#/components/schemas/AdminBatchUpdateProductVariant'
delete:
type: array
description: The product variants to delete.
@@ -43702,6 +43702,92 @@ components:
type: boolean
title: deleted
description: Whether the product variants were deleted.
AdminBatchUpdateProductVariant:
type: object
description: The properties to update of a product variant.
x-schemaName: AdminBatchUpdateProductVariant
properties:
title:
type: string
title: title
description: The product variant's title.
sku:
type: string
title: sku
description: The product variant's SKU.
ean:
type: string
title: ean
description: The product variant's EAN.
upc:
type: string
title: upc
description: The product variant's UPC.
barcode:
type: string
title: barcode
description: The product variant's barcode.
hs_code:
type: string
title: hs_code
description: The product variant's HS code.
mid_code:
type: string
title: mid_code
description: The product variant's MID code.
allow_backorder:
type: boolean
title: allow_backorder
description: Whether customers can order the variant even if it's not in stock.
manage_inventory:
type: boolean
title: manage_inventory
description: Whether the Medusa application manages the variant's inventory. If disabled, the product variant is always considered in stock.
variant_rank:
type: number
title: variant_rank
description: The product variant's rank among its siblings.
weight:
type: number
title: weight
description: The product variant's weight.
length:
type: number
title: length
description: The product variant's length.
height:
type: number
title: height
description: The product variant's height.
width:
type: number
title: width
description: The product variant's width.
origin_country:
type: string
title: origin_country
description: The product variant's origin country.
material:
type: string
title: material
description: The product variant's material.
metadata:
type: object
description: The product variant's metadata, can hold custom key-value pairs.
prices:
type: array
description: The product variant's prices.
items:
$ref: '#/components/schemas/AdminCreateProductVariantPrice'
options:
type: object
description: The product variant's options.
id:
type: string
title: id
description: The update's ID.
required:
- id
AdminCampaign:
type: object
description: The campaign's details.

2
www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantRequest.yaml
View File

@@ -11,7 +11,7 @@ properties:
type: array
description: The product variants to update.
items:
$ref: ./AdminUpdateProductVariant.yaml
$ref: ./AdminBatchUpdateProductVariant.yaml
delete:
type: array
description: The product variants to delete.

87
www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProductVariant.yaml Normal file
View File

@@ -0,0 +1,87 @@
type: object
description: The properties to update of a product variant.
x-schemaName: AdminBatchUpdateProductVariant
properties:
title:
type: string
title: title
description: The product variant's title.
sku:
type: string
title: sku
description: The product variant's SKU.
ean:
type: string
title: ean
description: The product variant's EAN.
upc:
type: string
title: upc
description: The product variant's UPC.
barcode:
type: string
title: barcode
description: The product variant's barcode.
hs_code:
type: string
title: hs_code
description: The product variant's HS code.
mid_code:
type: string
title: mid_code
description: The product variant's MID code.
allow_backorder:
type: boolean
title: allow_backorder
description: Whether customers can order the variant even if it's not in stock.
manage_inventory:
type: boolean
title: manage_inventory
description: >-
Whether the Medusa application manages the variant's inventory. If
disabled, the product variant is always considered in stock.
variant_rank:
type: number
title: variant_rank
description: The product variant's rank among its siblings.
weight:
type: number
title: weight
description: The product variant's weight.
length:
type: number
title: length
description: The product variant's length.
height:
type: number
title: height
description: The product variant's height.
width:
type: number
title: width
description: The product variant's width.
origin_country:
type: string
title: origin_country
description: The product variant's origin country.
material:
type: string
title: material
description: The product variant's material.
metadata:
type: object
description: The product variant's metadata, can hold custom key-value pairs.
prices:
type: array
description: The product variant's prices.
items:
$ref: ./AdminCreateProductVariantPrice.yaml
options:
type: object
description: The product variant's options.
id:
type: string
title: id
description: The update's ID.
required:
- id

88
www/apps/api-reference/specs/store/openapi.full.yaml
View File

@@ -5681,7 +5681,7 @@ components:
type: array
description: The product variants to update.
items:
$ref: '#/components/schemas/AdminUpdateProductVariant'
$ref: '#/components/schemas/AdminBatchUpdateProductVariant'
delete:
type: array
description: The product variants to delete.
@@ -5732,6 +5732,92 @@ components:
type: boolean
title: deleted
description: Whether the product variants were deleted.
AdminBatchUpdateProductVariant:
type: object
description: The properties to update of a product variant.
x-schemaName: AdminBatchUpdateProductVariant
properties:
title:
type: string
title: title
description: The product variant's title.
sku:
type: string
title: sku
description: The product variant's SKU.
ean:
type: string
title: ean
description: The product variant's EAN.
upc:
type: string
title: upc
description: The product variant's UPC.
barcode:
type: string
title: barcode
description: The product variant's barcode.
hs_code:
type: string
title: hs_code
description: The product variant's HS code.
mid_code:
type: string
title: mid_code
description: The product variant's MID code.
allow_backorder:
type: boolean
title: allow_backorder
description: Whether customers can order the variant even if it's not in stock.
manage_inventory:
type: boolean
title: manage_inventory
description: Whether the Medusa application manages the variant's inventory. If disabled, the product variant is always considered in stock.
variant_rank:
type: number
title: variant_rank
description: The product variant's rank among its siblings.
weight:
type: number
title: weight
description: The product variant's weight.
length:
type: number
title: length
description: The product variant's length.
height:
type: number
title: height
description: The product variant's height.
width:
type: number
title: width
description: The product variant's width.
origin_country:
type: string
title: origin_country
description: The product variant's origin country.
material:
type: string
title: material
description: The product variant's material.
metadata:
type: object
description: The product variant's metadata, can hold custom key-value pairs.
prices:
type: array
description: The product variant's prices.
items:
$ref: '#/components/schemas/AdminCreateProductVariantPrice'
options:
type: object
description: The product variant's options.
id:
type: string
title: id
description: The update's ID.
required:
- id
AdminCampaign:
type: object
description: The campaign's details.

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

@@ -13,7 +13,7 @@
* type: array
* description: The product variants to update.
* items:
* $ref: "#/components/schemas/AdminUpdateProductVariant"
* $ref: "#/components/schemas/AdminBatchUpdateProductVariant"
* delete:
* type: array
* description: The product variants to delete.

90
www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts Normal file
View File

@@ -0,0 +1,90 @@
/**
* @schema AdminBatchUpdateProductVariant
* type: object
* description: The properties to update of a product variant.
* x-schemaName: AdminBatchUpdateProductVariant
* properties:
* title:
* type: string
* title: title
* description: The product variant's title.
* sku:
* type: string
* title: sku
* description: The product variant's SKU.
* ean:
* type: string
* title: ean
* description: The product variant's EAN.
* upc:
* type: string
* title: upc
* description: The product variant's UPC.
* barcode:
* type: string
* title: barcode
* description: The product variant's barcode.
* hs_code:
* type: string
* title: hs_code
* description: The product variant's HS code.
* mid_code:
* type: string
* title: mid_code
* description: The product variant's MID code.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: Whether customers can order the variant even if it's not in stock.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: Whether the Medusa application manages the variant's inventory. If disabled, the product variant is always considered in stock.
* variant_rank:
* type: number
* title: variant_rank
* description: The product variant's rank among its siblings.
* weight:
* type: number
* title: weight
* description: The product variant's weight.
* length:
* type: number
* title: length
* description: The product variant's length.
* height:
* type: number
* title: height
* description: The product variant's height.
* width:
* type: number
* title: width
* description: The product variant's width.
* origin_country:
* type: string
* title: origin_country
* description: The product variant's origin country.
* material:
* type: string
* title: material
* description: The product variant's material.
* metadata:
* type: object
* description: The product variant's metadata, can hold custom key-value pairs.
* prices:
* type: array
* description: The product variant's prices.
* items:
* $ref: "#/components/schemas/AdminCreateProductVariantPrice"
* options:
* type: object
* description: The product variant's options.
* id:
* type: string
* title: id
* description: The update's ID.
* required:
* - id
*
*/