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

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-20 14:13:44 +03:00
committed by GitHub
parent 9dcd62c731
commit da05999f13
20 changed files with 36 additions and 32 deletions

View File

@@ -17,7 +17,7 @@ properties:
images:
description: >-
An array of images of the Product. Each value in the array is a URL to the
image. You can use the upload endpoints to upload the image and obtain a
image. You can use the upload API Routes to upload the image and obtain a
URL.
type: array
items:
@@ -25,7 +25,8 @@ properties:
thumbnail:
description: >-
The thumbnail to use for the Product. The value is a URL to the thumbnail.
You can use the upload endpoints to upload the thumbnail and obtain a URL.
You can use the upload API Routes to upload the thumbnail and obtain a
URL.
type: string
handle:
description: >-

View File

@@ -27,7 +27,7 @@ properties:
images:
description: >-
An array of images of the Product. Each value in the array is a URL to the
image. You can use the upload endpoints to upload the image and obtain a
image. You can use the upload API Routes to upload the image and obtain a
URL.
type: array
items:
@@ -35,7 +35,8 @@ properties:
thumbnail:
description: >-
The thumbnail to use for the Product. The value is a URL to the thumbnail.
You can use the upload endpoints to upload the thumbnail and obtain a URL.
You can use the upload API Routes to upload the thumbnail and obtain a
URL.
type: string
handle:
description: >-

View File

@@ -13,8 +13,8 @@ tags:
that, they can create an Oauth provider within the plugin that handles the
authentication.
The Apps Oauth API Routes allows admins to manage and generate token for an
app using its oauth provider.
The Apps Oauth API Routes allows admins to manage and generate token for
an app using its oauth provider.
- name: Auth
description: >
Authentication API Routes allow admin users to manage their session, such
@@ -41,8 +41,8 @@ tags:
A store can use unlimited currencies, and each region must be associated
with at least one currency.
Currencies are defined within the Medusa backend. Currency API Routes allow
admins to list and update currencies.
Currencies are defined within the Medusa backend. Currency API Routes
allow admins to list and update currencies.
externalDocs:
description: How to manage currencies
url: >-

View File

@@ -93,7 +93,7 @@ delete:
Delete the current session for the logged in user. This will only work if
you're using Cookie session for authentication. If the API token is still
passed in the header, the user is still authorized to perform admin
functionalities in other endpoints.
functionalities in other API Routes.
x-codegen:
method: deleteSession
x-codeSamples:

View File

@@ -270,7 +270,7 @@ post:
description: >-
Create a Batch Job to be executed asynchronously in the Medusa backend. If
`dry_run` is set to `true`, the batch job will not be executed until the it
is confirmed, which can be done using the Confirm Batch Job endpoint.
is confirmed, which can be done using the Confirm Batch Job API Route.
externalDocs:
description: How to create a batch job
url: https://docs.medusajs.com/development/batch-jobs/create#create-batch-job

View File

@@ -3,7 +3,7 @@ post:
summary: Confirm a Batch Job
description: >-
When a batch job is created, it is not executed automatically if `dry_run`
is set to `true`. This endpoint confirms that the batch job should be
is set to `true`. This API Route confirms that the batch job should be
executed.
x-authenticated: true
parameters:

View File

@@ -281,7 +281,7 @@ post:
summary: Create a Product
x-authenticated: true
description: >-
Create a new Product. This endpoint can also be used to create a gift card
Create a new Product. This API Route can also be used to create a gift card
if the `is_giftcard` field is set to `true`.
requestBody:
content: