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

chore(docs): Updated API Reference (#2903)

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

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-12-26 16:30:38 +00:00
committed by GitHub
parent 1f1b85afbb
commit d93d337df7
30 changed files with 3521 additions and 3521 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}_batch.yaml
View File

@@ -1,6 +1,6 @@
post:
operationId: PostDiscountsDiscountConditionsConditionBatch
summary: Add a batch of resources to a discount condition
summary: Add Batch Resources
description: Add a batch of resources to a discount condition.
x-authenticated: true
parameters:
@@ -76,7 +76,7 @@ post:
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteDiscountsDiscountConditionsConditionBatch
summary: Delete a batch of resources from a discount condition
summary: Delete Batch Resources
description: Delete a batch of resources from a discount condition.
x-authenticated: true
parameters:

6
docs/api/admin/paths/order-edits_{id}.yaml
View File

@@ -1,7 +1,7 @@
delete:
operationId: DeleteOrderEditsOrderEdit
summary: Delete an Order Edit
description: Deletes an Order Edit
description: Delete an Order Edit
x-authenticated: true
parameters:
- in: path
@@ -47,7 +47,7 @@ delete:
$ref: ../components/responses/400_error.yaml
get:
operationId: GetOrderEditsOrderEdit
summary: Retrieve an OrderEdit
summary: Get an OrderEdit
description: Retrieves a OrderEdit.
x-authenticated: true
parameters:
@@ -105,7 +105,7 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostOrderEditsOrderEdit
summary: Updates an OrderEdit
summary: Update an OrderEdit
description: Updates a OrderEdit.
x-authenticated: true
parameters:

2
docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml
View File

@@ -1,6 +1,6 @@
delete:
operationId: DeleteOrderEditsOrderEditItemChange
summary: Delete an Order Edit Item Change
summary: Delete a Line Item Change
description: Deletes an Order Edit Item Change
x-authenticated: true
parameters:

2
docs/api/admin/paths/order-edits_{id}_items.yaml
View File

@@ -1,6 +1,6 @@
post:
operationId: PostOrderEditsEditLineItems
summary: Add an line item to an order (edit)
summary: Add a Line Item
description: Create an OrderEdit LineItem.
parameters:
- in: path

4
docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml
View File

@@ -1,6 +1,6 @@
delete:
operationId: DeleteOrderEditsOrderEditLineItemsLineItem
summary: Delete line items from an order edit and create change item
summary: Delete a Line Item
description: Delete line items from an order edit and create change item
x-authenticated: true
parameters:
@@ -55,7 +55,7 @@ delete:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostOrderEditsEditLineItemsLineItem
summary: Create or update the order edit change holding the line item changes
summary: Upsert Line Item Change
description: Create or update the order edit change holding the line item changes
x-authenticated: true
parameters:

2
docs/api/admin/paths/order-edits_{id}_request.yaml
View File

@@ -1,6 +1,6 @@
post:
operationId: PostOrderEditsOrderEditRequest
summary: Request order edit confirmation
summary: Request Confirmation
description: Request customer confirmation of an Order Edit
x-authenticated: true
parameters:

6
docs/api/admin/paths/payment-collections_{id}.yaml
View File

@@ -1,6 +1,6 @@
delete:
operationId: DeletePaymentCollectionsPaymentCollection
summary: Delete a Payment Collection
summary: Del a PaymentCollection
description: Deletes a Payment Collection
x-authenticated: true
parameters:
@@ -49,7 +49,7 @@ delete:
$ref: ../components/responses/unauthorized.yaml
get:
operationId: GetPaymentCollectionsPaymentCollection
summary: Retrieve an PaymentCollection
summary: Get a PaymentCollection
description: Retrieves a PaymentCollection.
x-authenticated: true
parameters:
@@ -107,7 +107,7 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostPaymentCollectionsPaymentCollection
summary: Updates a PaymentCollection
summary: Update PaymentCollection
description: Updates a PaymentCollection.
x-authenticated: true
parameters:

2
docs/api/admin/paths/payment-collections_{id}_authorize.yaml
View File

@@ -1,6 +1,6 @@
post:
operationId: PostPaymentCollectionsPaymentCollectionAuthorize
summary: Set the status of PaymentCollection as Authorized
summary: Mark Authorized
description: Sets the status of PaymentCollection as Authorized.
x-authenticated: true
parameters:

2
docs/api/admin/paths/publishable-api-key_{id}.yaml
View File

@@ -1,6 +1,6 @@
post:
operationId: PostPublishableApiKysPublishableApiKey
summary: Updates a PublishableApiKey
summary: Update PublishableApiKey
description: Updates a PublishableApiKey.
x-authenticated: true
parameters:

2
docs/api/admin/paths/publishable-api-keys.yaml
View File

@@ -1,6 +1,6 @@
post:
operationId: PostPublishableApiKeys
summary: Create a PublishableApiKey
summary: Create PublishableApiKey
description: Creates a PublishableApiKey.
requestBody:
content:

4
docs/api/admin/paths/publishable-api-keys_{id}.yaml
View File

@@ -1,6 +1,6 @@
delete:
operationId: DeletePublishableApiKeysPublishableApiKey
summary: Delete a PublishableApiKey
summary: Delete PublishableApiKey
description: Deletes a PublishableApiKeys
x-authenticated: true
parameters:
@@ -47,7 +47,7 @@ delete:
$ref: ../components/responses/400_error.yaml
get:
operationId: GetPublishableApiKeysPublishableApiKey
summary: Get a Publishable API Key
summary: Get a PublishableApiKey
description: Retrieve the Publishable Api Key.
parameters:
- in: path

2
docs/api/admin/paths/publishable-api-keys_{id}_revoke.yaml
View File

@@ -1,6 +1,6 @@
post:
operationId: PostPublishableApiKeysPublishableApiKeyRevoke
summary: Revoke a PublishableApiKey
summary: Revoke PublishableApiKey
description: Revokes a PublishableApiKey.
parameters:
- in: path

2
docs/api/admin/paths/publishable-api-keys_{id}_sales-channels.yaml
View File

@@ -1,6 +1,6 @@
get:
operationId: GetPublishableApiKeySalesChannels
summary: List PublishableApiKey's SalesChannels
summary: List SalesChannels
description: List PublishableApiKey's SalesChannels
x-authenticated: true
parameters:

4
docs/api/admin/paths/publishable-api-keys_{id}_sales-channels_batch.yaml
View File

@@ -1,6 +1,6 @@
post:
operationId: PostPublishableApiKeySalesChannelsChannelsBatch
summary: Add sales channel to a publishable api key scope
summary: Add SalesChannels
description: Assign a batch of sales channels to a publishable api key.
x-authenticated: true
parameters:
@@ -55,7 +55,7 @@ post:
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeletePublishableApiKeySalesChannelsChannelsBatch
summary: Remove sales channel from a publishable api key scope
summary: Delete SalesChannels
description: Remove a batch of sales channels from a publishable api key.
x-authenticated: true
parameters:

6
docs/api/admin/paths/uploads_protected.yaml
View File

@@ -1,9 +1,9 @@
post:
operationId: PostUploadsProtected
summary: Upload files with acl or in a non-public bucket
summary: Protected File Upload
description: >-
Uploads at least one file to the specific fileservice that is installed in
Medusa.
Uploads at least one file with ACL or a non-public bucket to the specific
fileservice that is installed in Medusa.
x-authenticated: true
requestBody:
content: