chore(docs): Generated API Reference (#2927)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
19d7be31eb
commit
cd32795595
@@ -0,0 +1,9 @@
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
|
||||
// must be previously logged in or use api token
|
||||
medusa.admin.uploads.delete({
|
||||
file_key
|
||||
})
|
||||
.then(({ id, object, deleted }) => {
|
||||
console.log(id);
|
||||
});
|
||||
@@ -0,0 +1,9 @@
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
|
||||
// must be previously logged in or use api token
|
||||
medusa.admin.uploads.getPresignedDownloadUrl({
|
||||
file_key
|
||||
})
|
||||
.then(({ download_url }) => {
|
||||
console.log(download_url);
|
||||
});
|
||||
@@ -0,0 +1,6 @@
|
||||
curl --location --request DELETE 'https://medusa-url.com/admin/uploads' \
|
||||
--header 'Authorization: Bearer {api_token}' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"file_key": "{file_key}"
|
||||
}'
|
||||
@@ -0,0 +1,6 @@
|
||||
curl --location --request POST 'https://medusa-url.com/admin/uploads/download-url' \
|
||||
--header 'Authorization: Bearer {api_token}' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"file_key": "{file_key}"
|
||||
}'
|
||||
@@ -193,6 +193,10 @@ paths:
|
||||
$ref: paths/collections.yaml
|
||||
/collections/{id}:
|
||||
$ref: paths/collections_{id}.yaml
|
||||
/currencies:
|
||||
$ref: paths/currencies.yaml
|
||||
/currencies/{code}:
|
||||
$ref: paths/currencies_{code}.yaml
|
||||
/customer-groups/{id}/customers/batch:
|
||||
$ref: paths/customer-groups_{id}_customers_batch.yaml
|
||||
/customer-groups:
|
||||
@@ -201,10 +205,6 @@ paths:
|
||||
$ref: paths/customer-groups_{id}.yaml
|
||||
/customer-groups/{id}/customers:
|
||||
$ref: paths/customer-groups_{id}_customers.yaml
|
||||
/currencies:
|
||||
$ref: paths/currencies.yaml
|
||||
/currencies/{code}:
|
||||
$ref: paths/currencies_{code}.yaml
|
||||
/customers:
|
||||
$ref: paths/customers.yaml
|
||||
/customers/{id}:
|
||||
@@ -227,10 +227,6 @@ paths:
|
||||
$ref: paths/discounts_{id}_dynamic-codes_{code}.yaml
|
||||
/discounts/code/{code}:
|
||||
$ref: paths/discounts_code_{code}.yaml
|
||||
/gift-cards:
|
||||
$ref: paths/gift-cards.yaml
|
||||
/gift-cards/{id}:
|
||||
$ref: paths/gift-cards_{id}.yaml
|
||||
/draft-orders:
|
||||
$ref: paths/draft-orders.yaml
|
||||
/draft-orders/{id}/line-items:
|
||||
@@ -243,6 +239,10 @@ paths:
|
||||
$ref: paths/draft-orders_{id}_pay.yaml
|
||||
/admin/draft-orders/{id}:
|
||||
$ref: paths/admin_draft-orders_{id}.yaml
|
||||
/gift-cards:
|
||||
$ref: paths/gift-cards.yaml
|
||||
/gift-cards/{id}:
|
||||
$ref: paths/gift-cards_{id}.yaml
|
||||
/invites/accept:
|
||||
$ref: paths/invites_accept.yaml
|
||||
/invites:
|
||||
@@ -329,6 +329,12 @@ paths:
|
||||
$ref: paths/payment-collections_{id}.yaml
|
||||
/payment-collections/{id}/authorize:
|
||||
$ref: paths/payment-collections_{id}_authorize.yaml
|
||||
/payments/{id}/capture:
|
||||
$ref: paths/payments_{id}_capture.yaml
|
||||
/payments/{id}:
|
||||
$ref: paths/payments_{id}.yaml
|
||||
/payments/{id}/refund:
|
||||
$ref: paths/payments_{id}_refund.yaml
|
||||
/price-lists/{id}/prices/batch:
|
||||
$ref: paths/price-lists_{id}_prices_batch.yaml
|
||||
/price-lists:
|
||||
@@ -341,10 +347,10 @@ paths:
|
||||
$ref: paths/price-lists_{id}_variants_{variant_id}_prices.yaml
|
||||
/price-lists/{id}/products:
|
||||
$ref: paths/price-lists_{id}_products.yaml
|
||||
/product-types:
|
||||
$ref: paths/product-types.yaml
|
||||
/product-tags:
|
||||
$ref: paths/product-tags.yaml
|
||||
/product-types:
|
||||
$ref: paths/product-types.yaml
|
||||
/products/{id}/options:
|
||||
$ref: paths/products_{id}_options.yaml
|
||||
/products:
|
||||
@@ -363,12 +369,6 @@ paths:
|
||||
$ref: paths/products_types.yaml
|
||||
/products/{id}/metadata:
|
||||
$ref: paths/products_{id}_metadata.yaml
|
||||
/payments/{id}/capture:
|
||||
$ref: paths/payments_{id}_capture.yaml
|
||||
/payments/{id}:
|
||||
$ref: paths/payments_{id}.yaml
|
||||
/payments/{id}/refund:
|
||||
$ref: paths/payments_{id}_refund.yaml
|
||||
/publishable-api-keys/{id}/sales-channels/batch:
|
||||
$ref: paths/publishable-api-keys_{id}_sales-channels_batch.yaml
|
||||
/publishable-api-keys:
|
||||
@@ -403,22 +403,26 @@ paths:
|
||||
$ref: paths/return-reasons.yaml
|
||||
/return-reasons/{id}:
|
||||
$ref: paths/return-reasons_{id}.yaml
|
||||
/sales-channels/{id}/products/batch:
|
||||
$ref: paths/sales-channels_{id}_products_batch.yaml
|
||||
/sales-channels:
|
||||
$ref: paths/sales-channels.yaml
|
||||
/sales-channels/{id}:
|
||||
$ref: paths/sales-channels_{id}.yaml
|
||||
/returns/{id}/cancel:
|
||||
$ref: paths/returns_{id}_cancel.yaml
|
||||
/returns:
|
||||
$ref: paths/returns.yaml
|
||||
/returns/{id}/receive:
|
||||
$ref: paths/returns_{id}_receive.yaml
|
||||
/sales-channels/{id}/products/batch:
|
||||
$ref: paths/sales-channels_{id}_products_batch.yaml
|
||||
/sales-channels:
|
||||
$ref: paths/sales-channels.yaml
|
||||
/sales-channels/{id}:
|
||||
$ref: paths/sales-channels_{id}.yaml
|
||||
/shipping-options:
|
||||
$ref: paths/shipping-options.yaml
|
||||
/shipping-options/{id}:
|
||||
$ref: paths/shipping-options_{id}.yaml
|
||||
/shipping-profiles:
|
||||
$ref: paths/shipping-profiles.yaml
|
||||
/shipping-profiles/{id}:
|
||||
$ref: paths/shipping-profiles_{id}.yaml
|
||||
/store/currencies/{code}:
|
||||
$ref: paths/store_currencies_{code}.yaml
|
||||
/store:
|
||||
@@ -441,14 +445,12 @@ paths:
|
||||
$ref: paths/tax-rates.yaml
|
||||
/tax-rates/{id}:
|
||||
$ref: paths/tax-rates_{id}.yaml
|
||||
/shipping-profiles:
|
||||
$ref: paths/shipping-profiles.yaml
|
||||
/shipping-profiles/{id}:
|
||||
$ref: paths/shipping-profiles_{id}.yaml
|
||||
/uploads/protected:
|
||||
$ref: paths/uploads_protected.yaml
|
||||
/uploads:
|
||||
$ref: paths/uploads.yaml
|
||||
/uploads/download-url:
|
||||
$ref: paths/uploads_download-url.yaml
|
||||
/users:
|
||||
$ref: paths/users.yaml
|
||||
/users/{id}:
|
||||
|
||||
@@ -57,3 +57,58 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
delete:
|
||||
operationId: AdminDeleteUploads
|
||||
summary: Delete an Uploaded File
|
||||
description: Removes an uploaded file using the installed fileservice
|
||||
x-authenticated: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminDeleteUploadsReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/uploads/deleteundefined
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/uploads/deleteundefined
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Upload
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The file key of the upload deleted
|
||||
object:
|
||||
type: string
|
||||
description: The type of the object that was deleted.
|
||||
default: file
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether or not the items were deleted.
|
||||
default: true
|
||||
'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
|
||||
|
||||
47
docs/api/admin/paths/uploads_download-url.yaml
Normal file
47
docs/api/admin/paths/uploads_download-url.yaml
Normal file
@@ -0,0 +1,47 @@
|
||||
post:
|
||||
operationId: PostUploadsDownloadUrl
|
||||
summary: Get a File's Download URL
|
||||
description: Creates a presigned download url for a file
|
||||
x-authenticated: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostUploadsDownloadUrlReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/uploads_download-url/postundefined
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/uploads_download-url/postundefined
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Upload
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
download_url:
|
||||
type: string
|
||||
description: The Download URL of the file
|
||||
'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
|
||||
Reference in New Issue
Block a user