Merge branch 'main' into variants-typo-edit

README.md

@@ -1,34 +1,9 @@
 # BigCommerce API Specifications
 
-This repo contains the OpenAPI Specifications (OAS) and JSON schema that form the human-readable [BigCommerce REST API Reference](https://developer.bigcommerce.com/docs/api).
+**As of December 27, 2023, you can find all the public BigCommerce DevDocs at [https://github.com/bigcommerce/docs](https://github.com/bigcommerce/docs)!**
 
-As of August 22, 2022, all API specification files are in OAS 3+ format. We also made significant changes to this repo in March 2023. Please update your fork to ensure you're working with the newest source files.
+This repository is archived and read only. The final commit has been tagged.
 
-## Contributing
+If you maintain API clients, the new [bigcommerce/docs](https://github.com/bigcommerce/docs) repo is now your source for the most up-to-date API specifications.
 
-If you're interested in contributing, see [CONTRIBUTING.md](CONTRIBUTING.md).
-
-## Directory structure
-
-```shell
-.
-├── .github/                           # github config
-    └── workflows/                     # workflows to lint pull requests, etc.
-├── .idea/                             # directory ignored by git - use for yourself
-├── models/                            # yml schema for various objects
-    ├── email_templates/               # email template schemas
-    ├── webhooks/                      # webhooks schemas
-    └── json2schema.py                 # script to convert json to yml
-├── reference/                         # openapi specification files
-    ├── catalog/                       # catalog OAS API reference
-    ├── payments/                      # payments OAS API reference
-    └── ...                            # other OAS API reference
-├── .eslintrc.json                     # config for MDX linter
-├── .gitignore                         # gitignore
-├── .spectral.yaml                     # config for OAS linter
-├── CONTRIBUTING                       # guidelines for contribution
-├── package-lock.json
-├── package.json
-├── pull_request_template.md           # template for most pull requests         
-└── README
-```
+This consolidation lets the BigCommerce DX team offer a more streamlined developer experience. [issues](https://github.com/bigcommerce/docs/issues), [discussions](https://github.com/bigcommerce/docs/discussions), and [pull requests](https://github.com/bigcommerce/docs/pulls) at [bigcommerce/docs](https://github.com/bigcommerce/docs)!

reference/abandoned_cart_emails.v3.yaml

@@ -363,7 +363,7 @@ components:
         body:
           type: string
           example: '''Complete your purchase <a href="{{ notification.checkout_link }}">{{notification.checkout.link}}'''
-        translation:
+        translations:
           type: array
           items:
             $ref: '#/components/schemas/TranslationDefinition'

reference/channels.v3.yml

@@ -996,6 +996,9 @@ components:
                   $ref: '#/components/schemas/ChannelWithoutCurrencies'
               meta:
                 $ref: '#/components/schemas/MetaWithFullPagination'
+            required:
+              - data
+              - meta
           examples:
             response:
               $ref: '#/components/examples/multiple_channels_without_currencies_resp_example'
@@ -1177,6 +1180,8 @@ components:
               $ref: '#/components/examples/error_422_channel_resp_example'
             Invalid Type and Platform Combination:
               $ref: '#/components/examples/error_422_invalid_type_platform_combination_resp_example'
+            Invalid Channel Name:
+              $ref: '#/components/examples/error_422_invalid_channel_name_resp_example'
     channel_not_found_resp:
       description: A *Channel* with the provided ID was not found.
       content:
@@ -1233,6 +1238,8 @@ components:
               $ref: '#/components/examples/error_422_prevent_update_type_and_platform_resp_example'
             Update Deleted Channel Error:
               $ref: '#/components/examples/error_422_prevent_update_deleted_channel_resp_example'
+            Update Channel Name Error:
+              $ref: '#/components/examples/error_422_invalid_channel_name_resp_example'
     missing_or_invalid_multiple_channels_currency_assignments_data_resp:
       description: The request is missing one or more required fields or invalid data is submitted.
       content:
@@ -1930,6 +1937,12 @@ components:
         title: A deleted channel cannot be updated. Channel can be restored within 90 days after deleting by contacting BigCommerce support team
         type: /api-docs/getting-started/api-status-codes
         errors: {}
+    error_422_invalid_channel_name_resp_example:
+      value:
+        status: 422
+        title: Only latin alphabet letters, arabic numerals, dash and underscore are allowed to be used as channel name.
+        type: /api-docs/getting-started/api-status-codes
+        errors: {}
     error_422_multiple_channels_currency_assignments_resp_example:
       value:
         status: 422
@@ -2193,7 +2206,7 @@ components:
         example-1: active
     ChannelName:
       type: string
-      description: Name of the channel as it will appear to merchants in the control panel.
+      description: Name of the channel as it will appear in the store control panel. The only characters it can include are Latin alphabet letters, Arabic numerals, dashes, and underscores.
       x-internal: false
       x-examples:
         example-1: string
@@ -2567,6 +2580,9 @@ components:
           $ref: '#/components/schemas/ChannelDateModified'
         icon_url:
           $ref: '#/components/schemas/IconUrl'
+      required:
+        - id
+        - name
       x-internal: false
     ChannelWithCurrencies:
       type: object
@@ -3049,5 +3065,4 @@ components:
           type: string
           description: |
             Description for the metafield.
-          example: Location in the warehouse
-
+          example: Location in the warehouse.