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

docs: generate API reference for 2.10.3 (#13548)

Browse Source 
* docs: generate API reference for 2.10.3

* fix curl example
This commit is contained in:
Shahed Nasser
2025-09-19 11:40:52 +03:00
committed by GitHub
parent 0e45249b30
commit 2f990a14e6
68 changed files with 4955 additions and 327 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
www/apps/api-reference/specs/admin/components/schemas/AdminColumn.yaml Normal file
View File

@@ -0,0 +1,118 @@
type: object
description: The details of a column in a view configuration.
x-schemaName: AdminColumn
required:
- id
- name
- field
- sortable
- hideable
- default_visible
- data_type
properties:
id:
type: string
title: id
description: The column's ID.
name:
type: string
title: name
description: The column's name. This is displayed in the view header.
description:
type: string
title: description
description: The column's description.
field:
type: string
title: field
description: The column's field in the entity.
sortable:
type: boolean
title: sortable
description: Whether the column is sortable.
hideable:
type: boolean
title: hideable
description: Whether the column is hideable.
default_visible:
type: boolean
title: default_visible
description: Whether the column is visible by default.
data_type:
type: string
description: The data type of the column's value.
enum:
- string
- number
- boolean
- object
- date
- currency
- enum
semantic_type:
type: string
title: semantic_type
description: >-
The column's semantic type. It can be `computed`, or other primitive
types.
context:
type: string
title: context
description: The column's context. It can be `display` or `generic`.
computed:
type: object
description: >-
A computed column's details. Only available if the column's
`semantic_type` is `computed`.
required:
- type
- required_fields
- optional_fields
properties:
type:
type: string
title: type
description: The computed's type for rendering.
required_fields:
type: array
description: The required fields in the computed column.
items:
type: string
title: required_fields
description: A required field in the computed column.
optional_fields:
type: array
description: The optional fields in the computed column.
items:
type: string
title: optional_fields
description: An optional field in the computed column.
relationship:
type: object
description: The relationship details. Only available for relationship columns.
required:
- entity
- field
properties:
entity:
type: string
title: entity
description: The related entity.
field:
type: string
title: field
description: The field in the related entity.
default_order:
type: number
title: default_order
description: The column's sort order in the default view configuration.
category:
type: string
description: The column's category.
enum:
- status
- metadata
- identifier
- timestamp
- metric
- relationship

64
www/apps/api-reference/specs/admin/components/schemas/AdminCreateViewConfiguration.yaml Normal file
View File

@@ -0,0 +1,64 @@
type: object
description: The details of a view configuration to create.
x-schemaName: AdminCreateViewConfiguration
properties:
is_system_default:
type: boolean
title: is_system_default
description: >-
Whether the view is the system default. If so, it will be used as the
default view for all users that don't have a custom active view set.
set_active:
type: boolean
title: set_active
description: Whether the view is set as active.
configuration:
type: object
description: The view's configuration.
required:
- visible_columns
- column_order
properties:
visible_columns:
type: array
description: The configuration's visible columns.
items:
type: string
title: visible_columns
description: The visible column's name.
column_order:
type: array
description: The columns in the order they should be displayed.
items:
type: string
title: column_order
description: The column's name.
search:
type: string
title: search
description: The search query used in the view.
column_widths:
type: object
description: The column widths in the view.
filters:
type: object
description: The filters applied to the view.
sorting:
type: object
description: The sorting applied to the view.
required:
- id
- desc
properties:
id:
type: string
title: id
description: The ID of the sorting column.
desc:
type: boolean
title: desc
description: Whether the sorting is descending.
name:
type: string
title: name
description: The view's name.

4
www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml
View File

@@ -38,3 +38,7 @@ properties:
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
location_id:
type: string
title: location_id
description: The ID of the location to which outbound items are sent from.

13
www/apps/api-reference/specs/admin/components/schemas/AdminSetActiveViewConfiguration.yaml Normal file
View File

@@ -0,0 +1,13 @@
type: object
description: The details of a view configuration to set as active for the given entity.
x-schemaName: AdminSetActiveViewConfiguration
required:
- view_configuration_id
properties:
view_configuration_id:
type: string
title: view_configuration_id
description: >-
The ID of the view configuration to set as active. If `null`, the active
view configuration will be cleared, and the `code` or system default view
configuration will be used as the active view.

59
www/apps/api-reference/specs/admin/components/schemas/AdminUpdateViewConfiguration.yaml Normal file
View File

@@ -0,0 +1,59 @@
type: object
description: The details to update in a view configuration.
x-schemaName: AdminUpdateViewConfiguration
properties:
set_active:
type: boolean
title: set_active
description: Whether the view is set as active.
name:
type: string
title: name
description: The view's name.
is_system_default:
type: boolean
title: is_system_default
description: Whether the view is the system default.
configuration:
type: object
description: The view's configuration.
properties:
search:
type: string
title: search
description: The search query used in the view.
visible_columns:
type: array
description: The configuration's visible columns.
items:
type: string
title: visible_columns
description: The visible column's name.
column_order:
type: array
description: The columns in the order they should be displayed.
items:
type: string
title: column_order
description: The column's name.
column_widths:
type: object
description: The column widths in the view.
filters:
type: object
description: The filters applied to the view.
sorting:
type: object
description: The sorting applied to the view.
required:
- id
- desc
properties:
id:
type: string
title: id
description: The ID of the sorting column.
desc:
type: boolean
title: desc
description: Whether the sorting is descending.

90
www/apps/api-reference/specs/admin/components/schemas/AdminViewConfiguration.yaml Normal file
View File

@@ -0,0 +1,90 @@
type: object
description: The details of a view configuration.
x-schemaName: AdminViewConfiguration
required:
- id
- entity
- name
- user_id
- is_system_default
- created_at
- updated_at
properties:
id:
type: string
title: id
description: The view configuration's ID.
entity:
type: string
title: entity
description: The entity the view configuration belongs to.
name:
type: string
title: name
description: The view configuration's name.
user_id:
type: string
title: user_id
description: >-
The ID of the user the view configuration belongs to. If `null`, the view
configuration is a system default.
is_system_default:
type: boolean
title: is_system_default
description: Whether the view configuration is the system default.
configuration:
type: object
description: The view's configuration.
required:
- visible_columns
- column_order
properties:
visible_columns:
type: array
description: The configuration's visible columns.
items:
type: string
title: visible_columns
description: The visible column's name.
column_order:
type: array
description: The columns in the order they should be displayed.
items:
type: string
title: column_order
description: The column's name.
column_widths:
type: object
description: The column widths in the view.
filters:
type: object
description: The filters applied to the view.
sorting:
type: object
description: The sorting applied to the view.
required:
- id
- desc
properties:
id:
type: string
title: id
description: The ID of the sorting column.
desc:
type: boolean
title: desc
description: Whether the sorting is descending.
search:
type: string
title: search
description: The configuration's search.
created_at:
type: string
format: date-time
title: created_at
description: The date the view configuration was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the view configuration was updated.

8
www/apps/api-reference/specs/admin/components/schemas/AdminViewConfigurationResponse.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
description: The details of a view configuration.
x-schemaName: AdminViewConfigurationResponse
required:
- view_configuration
properties:
view_configuration:
$ref: ./AdminViewConfiguration.yaml

11
www/apps/api-reference/specs/admin/components/schemas/AdminViewsEntityColumnsResponse.yaml Normal file
View File

@@ -0,0 +1,11 @@
type: object
description: The view's columns.
x-schemaName: AdminViewsEntityColumnsResponse
required:
- columns
properties:
columns:
type: array
description: The view's columns.
items:
$ref: ./AdminColumn.yaml

21
www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml
View File

@@ -1,21 +0,0 @@
type: object
description: The details of the line item to add.
x-schemaName: StoreAddCartLineItem
required:
- variant_id
- quantity
properties:
variant_id:
type: string
title: variant_id
description: The ID of the product variant to add to the cart.
quantity:
type: number
title: quantity
description: The item's quantity.
metadata:
type: object
description: The item's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata
description: Learn how to manage metadata

19
www/apps/api-reference/specs/admin/components/schemas/StoreAddCartShippingMethods.yaml
View File

@@ -1,19 +0,0 @@
type: object
description: The shipping method's details.
required:
- option_id
properties:
option_id:
type: string
title: option_id
description: The ID of the shipping option this method is created from.
data:
type: object
description: >-
Any additional data relevant for the third-party fulfillment provider to
process the shipment.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping#data-request-body-parameter
description: Learn more about the data parameter.
x-schemaName: StoreAddCartShippingMethods

16
www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml
View File

@@ -1,16 +0,0 @@
type: object
description: The details to update in the line item.
x-schemaName: StoreUpdateCartLineItem
required:
- quantity
properties:
quantity:
type: number
title: quantity
description: The item's quantity.
metadata:
type: object
description: The item's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata
description: Learn how to manage metadata