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

docs: generate API reference for 2.12.3 (#14341)

Browse Source
This commit is contained in:
Shahed Nasser
2025-12-17 18:19:46 +02:00
committed by GitHub
parent c0ec54fc15
commit 52e965f411
134 changed files with 7706 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml
View File

@@ -48,3 +48,8 @@ properties:
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
translations:
type: array
description: The collection's translations.
items:
$ref: ./AdminTranslation.yaml

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

@@ -0,0 +1,13 @@
type: object
description: The details of the order export.
x-schemaName: AdminExportOrderResponse
required:
- transaction_id
properties:
transaction_id:
type: string
title: transaction_id
description: >-
The ID of the workflow execution's transaction. Use it to check the status
of the export by sending a GET request to
`/admin/workflows-executions/export-orders/:transaction-id`

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

@@ -0,0 +1,34 @@
type: object
description: The locale's details.
x-schemaName: AdminLocale
required:
- code
- name
- created_at
- updated_at
- deleted_at
properties:
code:
type: string
title: code
description: The locale's code in BCP 47 format.
example: fr-FR
name:
type: string
title: name
description: The locale's display name.
created_at:
type: string
format: date-time
title: created_at
description: The date and time at which the locale was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date and time at which the locale was last updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date and time at which the locale was deleted.

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

@@ -0,0 +1,33 @@
type: object
description: The list of locales with pagination details.
x-schemaName: AdminLocaleListResponse
required:
- limit
- offset
- count
- locales
properties:
limit:
type: number
title: limit
description: The maximum number of locales returned.
offset:
type: number
title: offset
description: The number of locales skipped before retrieving the returned locales.
count:
type: number
title: count
description: The total number of locales matching the query.
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
locales:
type: array
description: The list of locales.
items:
$ref: ./AdminLocale.yaml

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

@@ -0,0 +1,8 @@
type: object
description: The locale's details.
x-schemaName: AdminLocaleResponse
required:
- locale
properties:
locale:
$ref: ./AdminLocale.yaml

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

@@ -0,0 +1,33 @@
type: object
description: The list of prices.
x-schemaName: AdminPriceListPriceListResponse
required:
- limit
- offset
- count
- prices
properties:
limit:
type: number
title: limit
description: The maximum number of prices returned.
offset:
type: number
title: offset
description: The number of items skipped before retrieving the prices.
count:
type: number
title: count
description: The total number of prices.
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
prices:
type: array
description: The list of prices.
items:
$ref: ./AdminPrice.yaml

5
www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml
View File

@@ -171,3 +171,8 @@ properties:
description: The date the product was deleted.
shipping_profile:
$ref: ./AdminShippingProfile.yaml
translations:
type: array
description: The product's translations.
items:
$ref: ./AdminTranslation.yaml

5
www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml
View File

@@ -36,3 +36,8 @@ properties:
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
translations:
type: array
description: The tag's translations.
items:
$ref: ./AdminTranslation.yaml

5
www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml
View File

@@ -36,3 +36,8 @@ properties:
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
translations:
type: array
description: The type's translations.
items:
$ref: ./AdminTranslation.yaml

5
www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml
View File

@@ -155,3 +155,8 @@ properties:
type: string
title: thumbnail
description: The variant's thumbnail.
translations:
type: array
description: The variant's translations.
items:
$ref: ./AdminTranslation.yaml

6
www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml
View File

@@ -5,6 +5,7 @@ required:
- id
- name
- supported_currencies
- supported_locales
- default_sales_channel_id
- default_region_id
- default_location_id
@@ -53,3 +54,8 @@ properties:
format: date-time
title: updated_at
description: The date the store was updated.
supported_locales:
type: array
description: The store's supported locales.
items:
$ref: ./AdminStoreLocale.yaml

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

@@ -0,0 +1,41 @@
type: object
description: The details of a store's locale.
x-schemaName: AdminStoreLocale
required:
- id
- locale_code
- store_id
- locale
- created_at
- updated_at
- deleted_at
properties:
id:
type: string
title: id
description: The locale's ID.
locale_code:
type: string
title: locale_code
description: The locale's code in BCP 47 format.
store_id:
type: string
title: store_id
description: The ID of the store to which the locale belongs.
locale:
$ref: ./AdminLocale.yaml
created_at:
type: string
format: date-time
title: created_at
description: The date the locale was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the locale was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the locale was deleted.

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

@@ -0,0 +1,57 @@
type: object
description: The translation's details.
x-schemaName: AdminTranslation
required:
- id
- reference_id
- reference
- locale_code
- translations
- created_at
- updated_at
- deleted_at
properties:
id:
type: string
title: id
description: The translation's ID.
reference_id:
type: string
title: reference_id
description: >-
The ID of the resource that the translation belongs to. For example, the
ID of a product.
example: prod_123
reference:
type: string
title: reference
description: The resource that the translation belongs to.
example: product
locale_code:
type: string
title: locale_code
description: The translation's locale code in BCP 47 format.
example: fr-FR
translations:
type: object
description: >-
The translation key-value pairs. Each key is a field in the resource, and
the value is the translated text.
example:
title: Chaussures
description: Des chaussures élégantes.
created_at:
type: string
format: date-time
title: created_at
description: The date that the translation was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date that the translation was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date that the translation was deleted.

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

@@ -0,0 +1,16 @@
type: object
description: The translation settings' details.
x-schemaName: AdminTranslationSettingsResponse
required:
- translatable_fields
properties:
translatable_fields:
type: object
description: >-
Key-value pairs of translatable fields for different entities. Each key is
an entity type, and the value is an array of fields that can be translated
for that entity.
example:
product:
- title
- description

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

@@ -0,0 +1,74 @@
type: object
description: The translation statistics details.
x-schemaName: AdminTranslationStatisticsResponse
required:
- statistics
properties:
statistics:
type: object
description: >-
The translation statistics for different entity types. The key is the
entity type, and the value is an object containing the statistics for that
entity type.
example:
product:
expected: 150
translated: 120
missing: 30
by_locale:
fr-FR:
expected: 150
translated: 120
missing: 30
required:
- by_locale
- expected
- translated
- missing
additionalProperties:
type: object
properties:
by_locale:
type: object
description: >-
The translation statistics of an entity type broken down by locale.
The key is the locale code in BCP 47 format, and the value is an
object containing the statistics for that locale.
example:
fr-FR:
expected: 150
translated: 120
missing: 30
required:
- expected
- translated
- missing
additionalProperties:
type: object
properties:
expected:
type: number
title: expected
description: The total number of translatable fields.
translated:
type: number
title: translated
description: The number of translated fields.
missing:
type: number
title: missing
description: The number of fields that are yet to be translated.
expected:
type: number
title: expected
description: The total number of translatable fields across specified locales.
translated:
type: number
title: translated
description: The number of translated fields across specified locales.
missing:
type: number
title: missing
description: >-
The number of fields that are yet to be translated across specified
locales.

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

@@ -0,0 +1,42 @@
type: object
description: The batch response for managing translations.
x-schemaName: AdminTranslationsBatchResponse
required:
- created
- updated
- deleted
properties:
created:
type: array
description: The created translations.
items:
$ref: ./AdminTranslation.yaml
updated:
type: array
description: The updated translations.
items:
$ref: ./AdminTranslation.yaml
deleted:
type: object
description: Summary of the deleted translations.
required:
- ids
- object
- deleted
properties:
ids:
type: array
description: The IDs of the deleted translations.
items:
type: string
title: ids
description: A translation ID.
object:
type: string
title: object
description: The type of object deleted.
default: translation
deleted:
type: boolean
title: deleted
description: Whether the translations were successfully deleted.

8
www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml
View File

@@ -17,3 +17,11 @@ properties:
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
locale:
type: string
title: locale
description: >-
The order's locale in [BCP
47](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1)
format.
example: en-US

5
www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml
View File

@@ -29,3 +29,8 @@ properties:
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
supported_locales:
type: array
description: The store's supported locales.
items:
$ref: ./AdminUpdateStoreSupportedLocale.yaml

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

@@ -0,0 +1,13 @@
type: object
description: The payload to update a store's supported locale.
x-schemaName: AdminUpdateStoreSupportedLocale
required:
- locale_code
properties:
locale_code:
type: string
title: locale_code
description: >-
The locale's code in [BCP 47
format](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1).
example: fr-FR

8
www/apps/api-reference/specs/admin/components/schemas/Order.yaml
View File

@@ -328,3 +328,11 @@ properties:
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
locale:
type: string
title: locale
description: >-
The order's locale in [BCP
47](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1)
format.
example: en-US

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

@@ -0,0 +1,19 @@
type: object
description: The store locale's details.
x-schemaName: StoreLocale
required:
- code
- name
properties:
code:
type: string
title: code
description: >-
The locale's code in [BCP 47
format](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1).
example: en-US
name:
type: string
title: name
description: The locale's display name.
example: English (United States)

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

@@ -0,0 +1,11 @@
type: object
description: The list of supported locales in the store.
x-schemaName: StoreLocaleListResponse
required:
- locales
properties:
locales:
type: array
description: The list of supported locales in the store.
items:
$ref: ./StoreLocale.yaml