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

chore(docs): Generated API Reference (v2) (#8318)

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-07-29 09:41:02 +02:00
committed by GitHub
parent 56f634da4b
commit e40b4c6183
134 changed files with 7310 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
www/apps/api-reference/specs/admin/components/schemas/AdminExportProductResponse.yaml
View File

@@ -2,9 +2,9 @@ type: object
description: SUMMARY
x-schemaName: AdminExportProductResponse
required:
- workflow_id
- transaction_id
properties:
workflow_id:
transaction_id:
type: string
title: workflow_id
description: The product's workflow id.
title: transaction_id
description: The product's transaction id.

24
www/apps/api-reference/specs/admin/components/schemas/AdminImportProductResponse.yaml
View File

@@ -2,9 +2,25 @@ type: object
description: SUMMARY
x-schemaName: AdminImportProductResponse
required:
- workflow_id
- transaction_id
- summary
properties:
workflow_id:
transaction_id:
type: string
title: workflow_id
description: The product's workflow id.
title: transaction_id
description: The product's transaction id.
summary:
type: object
description: The product's summary.
required:
- toCreate
- toUpdate
properties:
toCreate:
type: number
title: toCreate
description: The summary's tocreate.
toUpdate:
type: number
title: toUpdate
description: The summary's toupdate.

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

@@ -0,0 +1,33 @@
type: object
description: SUMMARY
x-schemaName: AdminPostClaimItemsReqSchema
properties:
items:
type: array
description: The claim's items.
items:
type: object
description: The item's items.
required:
- id
- quantity
properties:
id:
type: string
title: id
description: The item's ID.
quantity:
type: number
title: quantity
description: The item's quantity.
description:
type: string
title: description
description: The item's description.
internal_note:
type: string
title: internal_note
description: The item's internal note.
metadata:
type: object
description: The item's metadata.

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

@@ -0,0 +1,33 @@
type: object
description: SUMMARY
x-schemaName: AdminPostClaimsAddItemsReqSchema
properties:
items:
type: array
description: The claim's items.
items:
type: object
description: The item's items.
required:
- variant_id
- quantity
properties:
variant_id:
type: string
title: variant_id
description: The item's variant id.
quantity:
type: number
title: quantity
description: The item's quantity.
unit_price:
type: number
title: unit_price
description: The item's unit price.
internal_note:
type: string
title: internal_note
description: The item's internal note.
metadata:
type: object
description: The item's metadata.

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

@@ -0,0 +1,12 @@
type: object
description: SUMMARY
x-schemaName: AdminPostClaimsItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The claim's quantity.
internal_note:
type: string
title: internal_note
description: The claim's internal note.

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

@@ -0,0 +1,15 @@
type: object
description: SUMMARY
x-schemaName: AdminPostClaimsShippingActionReqSchema
properties:
custom_price:
type: number
title: custom_price
description: The claim's custom price.
internal_note:
type: string
title: internal_note
description: The claim's internal note.
metadata:
type: object
description: The claim's metadata.

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

@@ -0,0 +1,25 @@
type: object
description: SUMMARY
x-schemaName: AdminPostClaimsShippingReqSchema
required:
- shipping_option_id
properties:
shipping_option_id:
type: string
title: shipping_option_id
description: The claim's shipping option id.
custom_price:
type: number
title: custom_price
description: The claim's custom price.
description:
type: string
title: description
description: The claim's description.
internal_note:
type: string
title: internal_note
description: The claim's internal note.
metadata:
type: object
description: The claim's metadata.

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

@@ -0,0 +1,28 @@
type: object
description: SUMMARY
x-schemaName: AdminPostOrderClaimsReqSchema
required:
- type
- order_id
- metadata
properties:
type:
type: string
enum:
- refund
- replace
order_id:
type: string
title: order_id
description: The claim's order id.
description:
type: string
title: description
description: The claim's description.
internal_note:
type: string
title: internal_note
description: The claim's internal note.
metadata:
type: object
description: The claim's metadata.

8
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml
View File

@@ -5,15 +5,15 @@ properties:
quantity:
type: number
title: quantity
description: The return's quantity.
description: The claim's quantity.
internal_note:
type: string
title: internal_note
description: The return's internal note.
description: The claim's internal note.
reason_id:
type: string
title: reason_id
description: The return's reason id.
description: The claim's reason id.
metadata:
type: object
description: The return's metadata.
description: The claim's metadata.

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

@@ -4,7 +4,7 @@ x-schemaName: AdminPostReturnsRequestItemsReqSchema
properties:
items:
type: array
description: The return's items.
description: The claim's items.
items:
type: object
description: The item's items.

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

@@ -0,0 +1,17 @@
type: object
description: SUMMARY
x-schemaName: AdminPostReturnsReturnReqSchema
required:
- metadata
properties:
location_id:
type: string
title: location_id
description: The return's location id.
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
metadata:
type: object
description: The return's metadata.

10
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml
View File

@@ -7,19 +7,19 @@ properties:
shipping_option_id:
type: string
title: shipping_option_id
description: The return's shipping option id.
description: The claim's shipping option id.
custom_price:
type: number
title: custom_price
description: The return's custom price.
description: The claim's custom price.
description:
type: string
title: description
description: The return's description.
description: The claim's description.
internal_note:
type: string
title: internal_note
description: The return's internal note.
description: The claim's internal note.
metadata:
type: object
description: The return's metadata.
description: The claim's metadata.

6
www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml
View File

@@ -81,13 +81,13 @@ properties:
type: string
title: id
description: The parent's ID.
metadata:
type: object
description: The parent's metadata.
handle:
type: string
title: handle
description: The parent's handle.
metadata:
type: object
description: The parent's metadata.
hs_code:
type: string
title: hs_code

6
www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml
View File

@@ -64,13 +64,13 @@ properties:
type: string
title: id
description: The product's ID.
metadata:
type: object
description: The product's metadata.
handle:
type: string
title: handle
description: The product's handle.
metadata:
type: object
description: The product's metadata.
hs_code:
type: string
title: hs_code