Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

Commit

Permalink
DEVDOCS-3396: [update] Catalog V3, mark url properties readOnly (#1267)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bc-tgomez
Sarah Riehl authored and bc-tgomez committed Apr 13, 2023
1 parent 1522823 commit c9a405d
Showing 1 changed file with 52 additions and 1 deletion.
53 changes: 52 additions & 1 deletion reference/catalog.v3.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1995,18 +1995,22 @@ paths:
The local path to the original image file uploaded to BigCommerce.
A `multipart/form-data` media type.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -2062,18 +2066,22 @@ paths:
The local path to the original image file uploaded to BigCommerce.
A `multipart/form-data` media type.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -2139,18 +2147,22 @@ paths:

A `multipart/form-data` media type.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -2190,18 +2202,22 @@ paths:
The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product.
A `multipart/form-data` media type.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -2424,18 +2440,22 @@ paths:
description: |
The local path to the original image file uploaded to BigCommerce.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -2474,18 +2494,22 @@ paths:
description: |
The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -18900,18 +18924,22 @@ components:
description: |
The local path to the original image file uploaded to BigCommerce.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -18958,18 +18986,22 @@ components:
description: |
The unique numeric identifier for the product with which the image is associated.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -20145,18 +20177,22 @@ components:
description: |
The unique numeric identifier for the product with which the image is associated.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -25310,18 +25346,22 @@ components:
description: |
The local path to the original image file uploaded to BigCommerce.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -25360,18 +25400,22 @@ components:
description: |
The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -25451,18 +25495,22 @@ components:
description: |
The local path to the original image file uploaded to BigCommerce.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -25501,18 +25549,22 @@ components:
description: |
The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
Expand Down Expand Up @@ -27632,4 +27684,3 @@ components:
For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes).
type: apiKey
in: header

0 comments on commit c9a405d

Please sign in to comment.