chore(oas): add note about returned fields in list product variants endpoint (#5360)

This commit is contained in:
Shahed Nasser
2023-10-12 14:55:13 +03:00
committed by GitHub
parent c02fdeb789
commit cacc443fc2
2 changed files with 10 additions and 2 deletions

View File

@@ -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.

View File

@@ -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