diff --git a/packages/medusa/src/api/routes/admin/products/list-variants.ts b/packages/medusa/src/api/routes/admin/products/list-variants.ts index 26a94453cc..bd1cd3f87b 100644 --- a/packages/medusa/src/api/routes/admin/products/list-variants.ts +++ b/packages/medusa/src/api/routes/admin/products/list-variants.ts @@ -12,7 +12,10 @@ import { validator } from "../../../../utils/validator" * @oas [get] /admin/products/{id}/variants * operationId: "GetProductsProductVariants" * summary: "List a Product's Variants" - * description: "Retrieve a list of Product Variants associated with a Product. The variants can be paginated." + * description: | + * Retrieve a list of Product Variants associated with a Product. The variants can be paginated. + * + * By default, each variant will only have the `id` and `variant_id` fields. You can use the `expand` and `fields` request parameters to retrieve more fields or relations. * x-authenticated: true * parameters: * - (path) id=* {string} ID of the product. diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml index ce7a0334f8..615092234c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml @@ -1,9 +1,14 @@ get: operationId: GetProductsProductVariants summary: List a Product's Variants - description: >- + description: > Retrieve a list of Product Variants associated with a Product. The variants can be paginated. + + + By default, each variant will only have the `id` and `variant_id` fields. + You can use the `expand` and `fields` request parameters to retrieve more + fields or relations. x-authenticated: true parameters: - in: path