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

chore(docs): Generated API Reference (#3308)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-22 14:45:23 +02:00
committed by GitHub
parent 3f5b7fbe7e
commit e3305188bd
31 changed files with 9056 additions and 8251 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/admin/paths/order_{id}_claims.yaml
+11
View File
@@ -10,6 +10,16 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -17,6 +27,7 @@ post:
$ref: ../components/schemas/AdminPostOrdersOrderClaimsReq.yaml
x-codegen:
method: createClaim
params: AdminPostOrdersOrderClaimsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml
+11
View File
@@ -16,6 +16,16 @@ post:
description: The ID of the Claim.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -23,6 +33,7 @@ post:
$ref: ../components/schemas/AdminPostOrdersOrderClaimsClaimReq.yaml
x-codegen:
method: updateClaim
params: AdminPostOrdersOrderClaimsClaimParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/order_{id}_swaps.yaml
+15
View File
@@ -12,6 +12,20 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded the order of the
result.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included the order of the
result.
schema:
type: string
requestBody:
content:
application/json:
@@ -19,6 +33,7 @@ post:
$ref: ../components/schemas/AdminPostOrdersOrderSwapsReq.yaml
x-codegen:
method: createSwap
queryParams: AdminPostOrdersOrderSwapsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}.yaml
+11
View File
@@ -68,6 +68,16 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -75,6 +85,7 @@ post:
$ref: ../components/schemas/AdminPostOrdersOrderReq.yaml
x-codegen:
method: update
params: AdminPostOrdersOrderParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_archive.yaml
+11
View File
@@ -10,8 +10,19 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: archive
params: AdminPostOrdersOrderArchiveParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_cancel.yaml
+11
View File
@@ -13,8 +13,19 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: cancel
params: AdminPostOrdersOrderCancel
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_capture.yaml
+11
View File
@@ -10,8 +10,19 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: capturePayment
params: AdminPostOrdersOrderCaptureParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml
+11
View File
@@ -16,8 +16,19 @@ post:
description: The ID of the Claim.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: cancelClaim
params: AdminPostOrdersClaimCancel
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml
+11
View File
@@ -16,6 +16,16 @@ post:
description: The ID of the Claim.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -24,6 +34,7 @@ post:
../components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml
x-codegen:
method: fulfillClaim
params: AdminPostOrdersOrderClaimsClaimFulfillmentsReq
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
+11
View File
@@ -22,8 +22,19 @@ post:
description: The ID of the Fulfillment.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: cancelClaimFulfillment
params: AdminPostOrdersClaimFulfillmentsCancelParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml
+11
View File
@@ -16,6 +16,16 @@ post:
description: The ID of the Claim.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -24,6 +34,7 @@ post:
../components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq.yaml
x-codegen:
method: createClaimShipment
params: AdminPostOrdersOrderClaimsClaimShipmentsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_complete.yaml
+11
View File
@@ -10,8 +10,19 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: complete
params: AdminPostOrdersOrderCompleteParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_fulfillment.yaml
+11
View File
@@ -12,6 +12,16 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -19,6 +29,7 @@ post:
$ref: ../components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml
x-codegen:
method: createFulfillment
params: AdminPostOrdersOrderFulfillmentsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
+11
View File
@@ -16,8 +16,19 @@ post:
description: The ID of the Fulfillment
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: cancelFulfillment
params: AdminPostOrdersOrderFulfillementsCancelParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_refund.yaml
+11
View File
@@ -10,6 +10,16 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -17,6 +27,7 @@ post:
$ref: ../components/schemas/AdminPostOrdersOrderRefundsReq.yaml
x-codegen:
method: refundPayment
params: AdminPostOrdersOrderRefundsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_return.yaml
+11
View File
@@ -12,6 +12,16 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -19,6 +29,7 @@ post:
$ref: ../components/schemas/AdminPostOrdersOrderReturnsReq.yaml
x-codegen:
method: requestReturn
params: AdminPostOrdersOrderReturnsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_shipment.yaml
+11
View File
@@ -10,6 +10,16 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -17,6 +27,7 @@ post:
$ref: ../components/schemas/AdminPostOrdersOrderShipmentReq.yaml
x-codegen:
method: createShipment
params: AdminPostOrdersOrderShipmentParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_shipping-methods.yaml
+11
View File
@@ -11,6 +11,16 @@ post:
description: The ID of the Order.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -19,6 +29,7 @@ post:
x-authenticated: true
x-codegen:
method: addShippingMethod
params: AdminPostOrdersOrderShippingMethodsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml
+11
View File
@@ -16,8 +16,19 @@ post:
description: The ID of the Swap.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: cancelSwap
params: AdminPostOrdersSwapCancelParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml
+11
View File
@@ -16,6 +16,16 @@ post:
description: The ID of the Swap.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -24,6 +34,7 @@ post:
../components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml
x-codegen:
method: fulfillSwap
params: AdminPostOrdersOrderSwapsSwapFulfillmentsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
+11
View File
@@ -22,8 +22,19 @@ post:
description: The ID of the Fulfillment.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: cancelSwapFulfillment
params: AdminPostOrdersSwapFulfillementsCancelParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml
+11
View File
@@ -19,8 +19,19 @@ post:
description: The ID of the Swap.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
x-codegen:
method: processSwapPayment
params: AdminPostOrdersOrderSwapsSwapProcessPaymentParams
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml
+11
View File
@@ -16,6 +16,16 @@ post:
description: The ID of the Swap.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
schema:
type: string
requestBody:
content:
application/json:
@@ -23,6 +33,7 @@ post:
$ref: ../components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq.yaml
x-codegen:
method: createSwapShipment
params: AdminPostOrdersOrderSwapsSwapShipmentsParams
x-codeSamples:
- lang: JavaScript
label: JS Client