chore(oas): add note about returned fields in list product variants endpoint (#5360)
This commit is contained in:
1 parent
c02fdeb789
commit
cacc443fc2
2 files changed
+10
-2
No files matched your search
@@ -12,7 +12,10 @@ import { validator } from "../../../../utils/validator"
|
|||||||
* @oas [get] /admin/products/{id}/variants
|
* @oas [get] /admin/products/{id}/variants
|
||||||
* operationId: "GetProductsProductVariants"
|
* operationId: "GetProductsProductVariants"
|
||||||
* summary: "List a Product's Variants"
|
* 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
|
* x-authenticated: true
|
||||||
* parameters:
|
* parameters:
|
||||||
* - (path) id=* {string} ID of the product.
|
* - (path) id=* {string} ID of the product.
|
||||||
|
|||||||
@@ -1,9 +1,14 @@
|
|||||||
get:
|
get:
|
||||||
operationId: GetProductsProductVariants
|
operationId: GetProductsProductVariants
|
||||||
summary: List a Product's Variants
|
summary: List a Product's Variants
|
||||||
description: >-
|
description: >
|
||||||
Retrieve a list of Product Variants associated with a Product. The variants
|
Retrieve a list of Product Variants associated with a Product. The variants
|
||||||
can be paginated.
|
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
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
|||||||
Reference in new issue
Block a user