From b408ea8e387dc927478b6d51aba60cb1ddfaea81 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Tue, 8 Aug 2023 15:52:29 -0500 Subject: [PATCH 1/2] add limits to description --- reference/catalog/products_catalog.v3.yml | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index ddbb23222..885baa823 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -875,6 +875,7 @@ paths: **Limits** - 250 characters product name length. + - A product can have up to 1000 images. There is a limit of 8 MB per image file or image uploaded by URL. **Usage Notes** * This endpoint accepts a `video` array. To create a product video that accepts a `video` object, see [Create a Product Video](/docs/rest-catalog/products/videos#create-a-product-video) for information. @@ -1484,6 +1485,9 @@ paths: description: | Updates a *Product*. + **Limits** + - A product can have up to 1000 images. There is a limit of 8 MB per image file or image uploaded by URL. + **Read-Only Fields** - id - date_created @@ -1986,9 +1990,10 @@ paths: **Usage Notes** - `image_url` - `255` character limit - - For file uploads, use the `multipart/form-data` media type - - Only one image at a time can be created + - For file uploads, use the `multipart/form-data` media type. + - You can create only one image at a time. A product can have up to 1000 images. - Supported image file types are BMP, GIF, JPEG, PNG, WBMP, XBM, and WEBP. + - There is a limit of 8 MB per image file or image uploaded by URL. operationId: createProductImage parameters: - $ref: '#/components/parameters/ContentType' @@ -2060,7 +2065,7 @@ paths: image_file: type: string description: | - Must be sent as a multipart/form-data field in the request body. Limit of 1MB per file. + Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file. multipart/form-data: schema: title: Product Image Post @@ -2131,7 +2136,7 @@ paths: image_file: type: string description: | - Must be sent as a multipart/form-data field in the request body. Limit of 1MB per file. + Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file. required: true responses: '200': @@ -2411,6 +2416,7 @@ paths: **Usage Notes** - `image_url` - `255` character limit + - There is a limit of 8 MB per image file or image uploaded by URL. - For file uploads, send a POST request using the `multipart/form-data` media type operationId: updateProductImage parameters: @@ -7008,7 +7014,7 @@ components: image_file: type: string description: | - The local path to the original image file uploaded to BigCommerce. Limit of 1MB per file. + The local path to the original image file uploaded to BigCommerce. Limit of 8 MB per file. is_thumbnail: type: boolean description: | From 1f8df008c17960e3d9d28224135555ef689cb496 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Tue, 8 Aug 2023 15:53:41 -0500 Subject: [PATCH 2/2] copyedit --- reference/catalog/products_catalog.v3.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 885baa823..02b5a62b7 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -875,7 +875,7 @@ paths: **Limits** - 250 characters product name length. - - A product can have up to 1000 images. There is a limit of 8 MB per image file or image uploaded by URL. + - A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB. **Usage Notes** * This endpoint accepts a `video` array. To create a product video that accepts a `video` object, see [Create a Product Video](/docs/rest-catalog/products/videos#create-a-product-video) for information. @@ -1486,7 +1486,7 @@ paths: Updates a *Product*. **Limits** - - A product can have up to 1000 images. There is a limit of 8 MB per image file or image uploaded by URL. + - A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB. **Read-Only Fields** - id @@ -1993,7 +1993,7 @@ paths: - For file uploads, use the `multipart/form-data` media type. - You can create only one image at a time. A product can have up to 1000 images. - Supported image file types are BMP, GIF, JPEG, PNG, WBMP, XBM, and WEBP. - - There is a limit of 8 MB per image file or image uploaded by URL. + - Each image file or image uploaded by URL can be up to 8 MB. operationId: createProductImage parameters: - $ref: '#/components/parameters/ContentType' @@ -2416,7 +2416,7 @@ paths: **Usage Notes** - `image_url` - `255` character limit - - There is a limit of 8 MB per image file or image uploaded by URL. + - Each image file or image uploaded by URL can be up to 8 MB. - For file uploads, send a POST request using the `multipart/form-data` media type operationId: updateProductImage parameters: