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

chore(docs): Generated API reference (#2788)

Browse Source
This commit is contained in:
Shahed Nasser
2022-12-13 12:52:58 +02:00
committed by GitHub
parent a77b4a1b7e
commit 52a8e90aac
413 changed files with 11540 additions and 4501 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/store/paths/auth.yaml
View File

@@ -22,6 +22,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
@@ -105,6 +106,7 @@ get:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml

1
docs/api/store/paths/auth_{email}.yaml
View File

@@ -27,6 +27,7 @@ get:
content:
application/json:
schema:
type: object
properties:
exists:
type: boolean

2
docs/api/store/paths/carts.yaml
View File

@@ -10,6 +10,7 @@ post:
content:
application/json:
schema:
type: object
properties:
region_id:
type: string
@@ -69,6 +70,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

3
docs/api/store/paths/carts_{id}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
@@ -54,6 +55,7 @@ post:
content:
application/json:
schema:
type: object
properties:
region_id:
type: string
@@ -132,6 +134,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

1
docs/api/store/paths/carts_{id}_complete.yaml
View File

@@ -36,6 +36,7 @@ post:
content:
application/json:
schema:
type: object
properties:
type:
type: string

1
docs/api/store/paths/carts_{id}_discounts_{code}.yaml
View File

@@ -32,6 +32,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

1
docs/api/store/paths/carts_{id}_line-items.yaml
View File

@@ -26,6 +26,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

2
docs/api/store/paths/carts_{id}_line-items_{line_id}.yaml
View File

@@ -33,6 +33,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
@@ -81,6 +82,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

1
docs/api/store/paths/carts_{id}_payment-session.yaml
View File

@@ -28,6 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

1
docs/api/store/paths/carts_{id}_payment-sessions.yaml
View File

@@ -28,6 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

2
docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}.yaml
View File

@@ -36,6 +36,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
@@ -85,6 +86,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

1
docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml
View File

@@ -38,6 +38,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

1
docs/api/store/paths/carts_{id}_shipping-methods.yaml
View File

@@ -26,6 +26,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

1
docs/api/store/paths/carts_{id}_taxes.yaml
View File

@@ -24,6 +24,7 @@ post:
content:
application/json:
schema:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml

1
docs/api/store/paths/collections.yaml
View File

@@ -78,6 +78,7 @@ get:
content:
application/json:
schema:
type: object
properties:
collections:
type: array

1
docs/api/store/paths/collections_{id}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
collection:
$ref: ../components/schemas/product_collection.yaml

3
docs/api/store/paths/customers.yaml
View File

@@ -6,6 +6,7 @@ post:
content:
application/json:
schema:
type: object
required:
- first_name
- last_name
@@ -46,6 +47,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
@@ -60,6 +62,7 @@ post:
content:
application/json:
schema:
type: object
properties:
code:
type: string

3
docs/api/store/paths/customers_me.yaml
View File

@@ -24,6 +24,7 @@ get:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
@@ -48,6 +49,7 @@ post:
content:
application/json:
schema:
type: object
properties:
first_name:
description: The Customer's first name.
@@ -93,6 +95,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml

2
docs/api/store/paths/customers_me_addresses.yaml
View File

@@ -7,6 +7,7 @@ post:
content:
application/json:
schema:
type: object
required:
- address
properties:
@@ -41,6 +42,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml

2
docs/api/store/paths/customers_me_addresses_{address_id}.yaml
View File

@@ -31,6 +31,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
@@ -85,6 +86,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml

1
docs/api/store/paths/customers_me_orders.yaml
View File

@@ -187,6 +187,7 @@ get:
content:
application/json:
schema:
type: object
properties:
orders:
type: array

1
docs/api/store/paths/customers_me_payment-methods.yaml
View File

@@ -25,6 +25,7 @@ get:
content:
application/json:
schema:
type: object
properties:
payment_methods:
type: array

2
docs/api/store/paths/customers_password-reset.yaml
View File

@@ -8,6 +8,7 @@ post:
content:
application/json:
schema:
type: object
required:
- email
- password
@@ -41,6 +42,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml

1
docs/api/store/paths/customers_password-token.yaml
View File

@@ -9,6 +9,7 @@ post:
content:
application/json:
schema:
type: object
required:
- email
properties:

1
docs/api/store/paths/gift-cards_{code}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
gift_card:
$ref: ../components/schemas/gift_card.yaml

1
docs/api/store/paths/order-edits_{id}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/order_edit.yaml

1
docs/api/store/paths/order-edits_{id}_complete.yaml
View File

@@ -26,6 +26,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/order_edit.yaml

2
docs/api/store/paths/order-edits_{id}_decline.yaml
View File

@@ -13,6 +13,7 @@ post:
content:
application/json:
schema:
type: object
properties:
declined_reason:
type: string
@@ -34,6 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/order_edit.yaml

1
docs/api/store/paths/orders.yaml
View File

@@ -46,6 +46,7 @@ get:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/order.yaml

47
docs/api/store/paths/orders_batch_customer_token.yaml Normal file
View File

@@ -0,0 +1,47 @@
post:
operationId: PostOrdersCustomerOrderClaim
summary: Claim orders for signed in account
description: >-
Sends an email to emails registered to orders provided with link to transfer
order ownership
requestBody:
content:
application/json:
schema:
required:
- order_ids
properties:
order_ids:
description: The ids of the orders to claim
type: array
items:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_batch_customer_token/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_batch_customer_token/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

1
docs/api/store/paths/orders_cart_{cart_id}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/order.yaml

45
docs/api/store/paths/orders_customer_confirm.yaml Normal file
View File

@@ -0,0 +1,45 @@
post:
operationId: PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept
summary: Verify a claim to orders
description: >-
Verifies the claim order token provided to the customer upon request of
order ownership
requestBody:
content:
application/json:
schema:
required:
- token
properties:
token:
description: The invite token provided by the admin.
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_customer_confirm/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_customer_confirm/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

1
docs/api/store/paths/orders_{id}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/order.yaml

58
docs/api/store/paths/payment-collections_{id}.yaml Normal file
View File

@@ -0,0 +1,58 @@
get:
operationId: GetPaymentCollectionsPaymentCollection
summary: Retrieve an PaymentCollection
description: Retrieves a PaymentCollection.
x-authenticated: false
parameters:
- in: path
name: id
required: true
description: The ID of the PaymentCollection.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payment-collections_{id}/getundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}/getundefined
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
payment_collection:
$ref: ../components/schemas/payment_collection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

58
docs/api/store/paths/payment-collections_{id}_sessions.yaml Normal file
View File

@@ -0,0 +1,58 @@
post:
operationId: PostPaymentCollectionsSessions
summary: Manage Payment Sessions from Payment Collections
description: Manages Payment Sessions from Payment Collections.
x-authenticated: false
parameters:
- in: path
name: id
required: true
description: The ID of the Payment Collection.
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- provider_id
properties:
provider_id:
type: string
description: The ID of the Payment Provider.
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}_sessions/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Payment
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
payment_collection:
$ref: ../components/schemas/payment_collection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

74
docs/api/store/paths/payment-collections_{id}_sessions_batch.yaml Normal file
View File

@@ -0,0 +1,74 @@
post:
operationId: PostPaymentCollectionsPaymentCollectionSessionsBatch
summary: Manage Multiple Payment Sessions from Payment Collections
description: Manages Multiple Payment Sessions from Payment Collections.
x-authenticated: false
parameters:
- in: path
name: id
required: true
description: The ID of the Payment Collections.
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
sessions:
description: >-
An array of payment sessions related to the Payment Collection.
If the session_id is not provided, existing sessions not present
will be deleted and the provided ones will be created.
type: array
items:
required:
- provider_id
- amount
properties:
provider_id:
type: string
description: The ID of the Payment Provider.
amount:
type: integer
description: The amount .
session_id:
type: string
description: The ID of the Payment Session to be updated.
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_batch/postundefined
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_batch/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Payment
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
payment_collection:
$ref: ../components/schemas/payment_collection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

59
docs/api/store/paths/payment-collections_{id}_sessions_batch_authorize.yaml Normal file
View File

@@ -0,0 +1,59 @@
post:
operationId: PostPaymentCollectionsSessionsBatchAuthorize
summary: Authorize Payment Sessions of a Payment Collection
description: Authorizes Payment Sessions of a Payment Collection.
x-authenticated: false
parameters:
- in: path
name: id
required: true
description: The ID of the Payment Collections.
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
session_ids:
description: List of Payment Session IDs to authorize.
type: array
items:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_batch_authorize/postundefined
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_batch_authorize/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Payment
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
payment_collection:
$ref: ../components/schemas/payment_collection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

68
docs/api/store/paths/payment-collections_{id}_sessions_{session_id}.yaml Normal file
View File

@@ -0,0 +1,68 @@
post:
operationId: PostPaymentCollectionsPaymentCollectionPaymentSessionsSession
summary: Refresh a Payment Session
description: >-
Refreshes a Payment Session to ensure that it is in sync with the Payment
Collection.
x-authenticated: false
parameters:
- in: path
name: id
required: true
description: The id of the PaymentCollection.
schema:
type: string
- in: path
name: session_id
required: true
description: The id of the Payment Session to be refreshed.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- provider_id
- customer_id
properties:
provider_id:
description: The Payment Provider id.
type: string
customer_id:
description: The Customer id.
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_{session_id}/postundefined
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_{session_id}/postundefined
tags:
- PaymentCollection
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
payment_session:
$ref: ../components/schemas/payment_session.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

55
docs/api/store/paths/payment-collections_{id}_sessions_{session_id}_authorize.yaml Normal file
View File

@@ -0,0 +1,55 @@
post:
operationId: PostPaymentCollectionsSessionsSessionAuthorize
summary: Authorize a Payment Session of a Payment Collection
description: Authorizes a Payment Session of a Payment Collection.
x-authenticated: false
parameters:
- in: path
name: id
required: true
description: The ID of the Payment Collections.
schema:
type: string
- in: path
name: session_id
required: true
description: The ID of the Payment Session.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_{session_id}_authorize/postundefined
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_{session_id}_authorize/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Payment
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
payment_session:
$ref: ../components/schemas/payment_session.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

1
docs/api/store/paths/product-types.yaml
View File

@@ -113,6 +113,7 @@ get:
content:
application/json:
schema:
type: object
properties:
product_types:
$ref: ../components/schemas/product_type.yaml

1
docs/api/store/paths/products.yaml
View File

@@ -164,6 +164,7 @@ get:
content:
application/json:
schema:
type: object
properties:
products:
type: array

1
docs/api/store/paths/products_search.yaml
View File

@@ -36,6 +36,7 @@ post:
content:
application/json:
schema:
type: object
properties:
hits:
type: array

1
docs/api/store/paths/products_{id}.yaml
View File

@@ -50,6 +50,7 @@ get:
content:
application/json:
schema:
type: object
properties:
product:
allOf:

1
docs/api/store/paths/regions.yaml
View File

@@ -76,6 +76,7 @@ get:
content:
application/json:
schema:
type: object
properties:
regions:
type: array

1
docs/api/store/paths/regions_{id}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
region:
$ref: ../components/schemas/region.yaml

1
docs/api/store/paths/return-reasons.yaml
View File

@@ -19,6 +19,7 @@ get:
content:
application/json:
schema:
type: object
properties:
return_reasons:
type: array

1
docs/api/store/paths/return-reasons_{id}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
return_reason:
$ref: ../components/schemas/return_reason.yaml

2
docs/api/store/paths/returns.yaml
View File

@@ -6,6 +6,7 @@ post:
content:
application/json:
schema:
type: object
required:
- order_id
- items
@@ -64,6 +65,7 @@ post:
content:
application/json:
schema:
type: object
properties:
return:
$ref: ../components/schemas/return.yaml

1
docs/api/store/paths/shipping-options.yaml
View File

@@ -37,6 +37,7 @@ get:
content:
application/json:
schema:
type: object
properties:
shipping_options:
type: array

1
docs/api/store/paths/shipping-options_{cart_id}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
shipping_options:
type: array

2
docs/api/store/paths/swaps.yaml
View File

@@ -8,6 +8,7 @@ post:
content:
application/json:
schema:
type: object
required:
- order_id
- return_items
@@ -72,6 +73,7 @@ post:
content:
application/json:
schema:
type: object
properties:
swap:
$ref: ../components/schemas/swap.yaml

1
docs/api/store/paths/swaps_{cart_id}.yaml
View File

@@ -26,6 +26,7 @@ get:
content:
application/json:
schema:
type: object
properties:
swap:
$ref: ../components/schemas/swap.yaml

1
docs/api/store/paths/variants.yaml
View File

@@ -75,6 +75,7 @@ get:
content:
application/json:
schema:
type: object
properties:
variants:
type: array

1
docs/api/store/paths/variants_{variant_id}.yaml
View File

@@ -42,6 +42,7 @@ get:
content:
application/json:
schema:
type: object
properties:
variant:
allOf: