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

chore(docs): Updated API Reference (automated) (#12461)

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

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-05-13 13:43:58 +00:00
committed by GitHub
parent 5c36bafc1d
commit c6c660c4d3
135 changed files with 2202 additions and 545 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
www/apps/api-reference/specs/admin/paths/admin_collections.yaml
View File

@@ -1008,7 +1008,33 @@ post:
content:
application/json:
schema:
$ref: ../components/schemas/AdminCreateCollection.yaml
allOf:
- type: object
description: The collection's details.
required:
- title
properties:
title:
type: string
title: title
description: The collection's title.
handle:
type: string
title: handle
description: The collection's handle.
metadata:
type: object
description: The collection's metadata. Can hold custom key-value pairs.
- type: object
description: The collection's details.
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: the product collection's details.
x-codeSamples:
- lang: JavaScript
label: JS SDK

26
www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml
View File

@@ -102,7 +102,31 @@ post:
content:
application/json:
schema:
$ref: ../components/schemas/AdminUpdateCollection.yaml
allOf:
- type: object
description: The details to update in a collection.
properties:
title:
type: string
title: title
description: The collection's title.
handle:
type: string
title: handle
description: The collection's handle.
metadata:
type: object
description: The collection's metadata.
- type: object
description: The details to update in a collection.
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: The details to update in a collection.
x-codeSamples:
- lang: JavaScript
label: JS SDK

14
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml
View File

@@ -1,7 +1,7 @@
delete:
operationId: DeleteOrderEditsId
summary: Cancel Order Edit
description: Cancel an order edit.
description: Cancel a requested order edit.
x-authenticated: true
parameters:
- name: id
@@ -64,3 +64,15 @@ delete:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: cancelBeginOrderEditWorkflow
x-events:
- name: order-edit.canceled
payload: |-
```ts
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
```
description: Emitted when an order edit request is canceled.
deprecated: false
version: 2.8.0

12
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml
View File

@@ -45,3 +45,15 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: confirmOrderEditRequestWorkflow
x-events:
- name: order-edit.confirmed
payload: |-
```ts
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
```
description: Emitted when an order edit request is confirmed.
deprecated: false
version: 2.8.0

12
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml
View File

@@ -45,3 +45,15 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: requestOrderEditRequestWorkflow
x-events:
- name: order-edit.requested
payload: |-
```ts
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
```
description: Emitted when an order edit is requested.
deprecated: false
version: 2.8.0

187
www/apps/api-reference/specs/admin/paths/admin_tax-providers.yaml Normal file
View File

@@ -0,0 +1,187 @@
get:
operationId: GetTaxProviders
summary: List Tax Providers
description: >-
Retrieve a list of tax providers installed in the Medusa application through
Tax Module Providers. The tax providers can be filtered by fields such as
`id`. The tax providers can also be sorted or paginated.
x-authenticated: true
parameters:
- name: fields
in: query
description: >-
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields.
without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: >-
Comma-separated fields that should be included in the returned data.
If a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. Without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
externalDocs:
url: '#pagination'
- name: id
in: query
required: false
schema:
oneOf:
- type: string
title: id
description: Filter by a tax provider's ID.
- type: array
description: Filter by tax provider IDs.
items:
type: string
title: id
description: A tax provider's ID.
- name: is_enabled
in: query
description: Filter by whether the tax provider is enabled.
required: false
schema:
type: boolean
title: is_enabled
description: Filter by whether the tax provider is enabled.
- name: $and
in: query
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $and
- name: $or
in: query
description: >-
Join query parameters with an OR condition. Each object's content is the
same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $or
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: JavaScript
label: JS SDK
source:
$ref: ../code_samples/JavaScript/admin_tax-providers/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_tax-providers/get.sh
tags:
- Tax Providers
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
description: The pagination details.
required:
- limit
- offset
- count
properties:
limit:
type: number
title: limit
description: The maximum number of items retrieved.
offset:
type: number
title: offset
description: >-
The number of items skipped before retrieving the returned
items.
count:
type: number
title: count
description: The total number of items available.
estimate_count:
type: number
title: estimate_count
description: >-
The estimated count retrieved from the PostgreSQL query
planner, which may be inaccurate.
x-featureFlag: index_engine
- type: object
description: The list of tax providers.
required:
- tax_providers
properties:
tax_providers:
type: array
description: The list of tax providers.
items:
$ref: ../components/schemas/AdminTaxProvider.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
x-version: 2.8.0

29
www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml
View File

@@ -30,6 +30,35 @@ get:
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: province_code
in: query
description: Filter by a tax region's province code.
required: false
schema:
type: string
title: province_code
description: Filter by a tax region's province code.
- name: provider_id
in: query
description: Filter by a tax provider ID to retrieve the tax regions using it.
required: false
schema:
type: string
title: provider_id
description: Filter by a tax provider ID to retrieve the tax regions using it.
- name: metadata
in: query
description: >-
Filter by a tax region's metadata. Refer to the [Object Query
Parameter](https://docs.medusajs.com/api/admin#object) section to learn
how to filter by object fields.
required: false
schema:
type: object
description: >-
Filter by a tax region's metadata. Refer to the [Object Query
Parameter](https://docs.medusajs.com/api/admin#object) section to
learn how to filter by object fields.
security:
- api_token: []
- cookie_auth: []

8
www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml
View File

@@ -86,6 +86,14 @@ get:
type: string
title: workflow_id
description: A workflow ID.
- name: q
in: query
description: Search query to filter by a workflow execution's searchable fields.
required: false
schema:
type: string
title: q
description: Search query to filter by a workflow execution's searchable fields.
security:
- api_token: []
- cookie_auth: []