CATALOG-9786: [update] Brands: REST Contract

bigcommerce · Jun 21, 2024 · e43fdaf · e43fdaf
1 parent 5724b83
commit e43fdaf
Showing 1 changed file with 10 additions and 10 deletions.
diff --git a/archive/rest-catalog/brands.v2.yaml b/archive/rest-catalog/brands.v2.yaml
@@ -1,6 +1,6 @@
 openapi: '3.0.3'
 info:
-  title: Catalog - Brands V2
+  title: Catalog - Brands V2 (Deprecated)
   description: |-
     Brand facets for identifying and categorizing products according to their manufacturer or company metonym.
     
@@ -30,7 +30,7 @@ paths:
     get:
       tags:
         - Brands V2
-      summary: Gets list of Brands.
+      summary: Gets list of Brands. (Deprecated)
       description: Gets the collection of Brands. (Default sorting is by brand id, from lowest to highest.)
       operationId: getBrands
       parameters:
@@ -51,7 +51,7 @@ paths:
     post:
       tags:
         - Brands V2
-      summary: Create a Brand.
+      summary: Create a Brand. (Deprecated)
       description: |-
         Creates a *Brand*.
 
@@ -66,8 +66,8 @@ paths:
         - id
         
         **Limits**
-        - 30 000 brands per store limit
-        To maximize system performance, BigCommerce caps the number of brands that can be added to a store at 30,000. If your POST causes the store to exceed the maximum of 30,000 brands, BigCommerce will return a 403 error.
+        - 30,000 brands per store limit
+        To maximize system performance, BigCommerce caps the number of brands you can add to a store at 30,000. If your POST causes the store to exceed the maximum of 30,000 brands, BigCommerce will return a 403 error.
       operationId: createBrand
       requestBody:
         content:
@@ -92,7 +92,7 @@ paths:
     delete:
       tags:
         - Brands V2
-      summary: Deletes all existing on store brands.
+      summary: Deletes all existing on store brands. (Deprecated)
       description: Deletes all existing on store brands.
       operationId: deleteBrands
       responses:
@@ -107,7 +107,7 @@ paths:
     get:
       tags:
         - Brands V2
-      summary: Gets a brand.
+      summary: Gets a brand. (Deprecated)
       description: Returns a single *Brand*.
       operationId: getBrandById
       responses:
@@ -124,7 +124,7 @@ paths:
     put:
       tags:
         - Brands V2
-      summary: Updates an existing Brand.
+      summary: Updates an existing Brand. (Deprecated)
       operationId: updateBrand
       description: |-
         Updates a *Brand*.
@@ -155,7 +155,7 @@ paths:
     delete:
       tags:
         - Brands V2
-      summary: Deletes a Brand.
+      summary: Deletes a Brand. (Deprecated)
       description: Deletes a *Brand*.
       operationId: deleteBrand
       responses:
@@ -174,7 +174,7 @@ paths:
     get:
       tags:
         - Brands V2
-      summary: Count Brands.
+      summary: Count Brands. (Deprecated)
       description: Returns the total number of brands in the store.
       operationId: getBrandsCount
       responses: