Skip to content

Commit

Permalink
DEVDOCS-6189: [update] field restrictions (#745)
Browse files Browse the repository at this point in the history
<!-- Ticket number or summary of work -->
# [DEVDOCS-6189]


## What changed?
Updated field restrictions for v3/catalog/trees/categories and
v3/catalog/categories endpoints

## Release notes draft

Bug Fix
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* 

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}


[DEVDOCS-6189]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6189?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
bc-traciporter authored Jan 15, 2025
1 parent 1c8c32e commit 957328b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
4 changes: 2 additions & 2 deletions reference/catalog/categories_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ paths:
- Categories (deprecated)
deprecated: true
summary: Create a Category
description: "When possible, use the [Category Trees - Create categories](/docs/rest-catalog/category-trees/categories#create-categories) endpoint instead.\n\nCreates a *Category*.\n\nUse this endpoint when an API only works with categories of a default BigCommerce storefront (`channel_id=1`). \n\nUse the [Create categories](/docs/rest-catalog/category-trees/categories#create-categories) endpoint when an API works with categories across different category trees that belong to different storefront channels.\n\n**Required Fields**:\n- `parent_id`: \n\t- To create a child category, set the `parent_id` to the parent category.\n\t- To create a top level category, set the `parent_id` to `0`.\n- `name`\n\n**Read-Only Fields**:\n- `id`\n\n**Limits**:\n- 16,000 categories per store limit.\n- 1,000 categories per product limit.\n- 50 characters category name length.\n- 8 levels of category depth limit.\n- 65,642 characters category description length limit.\n\n **Note:**\n The default rate limit for this endpoint is 40 concurrent requests.\n"
description: "When possible, use the [Category Trees - Create categories](/docs/rest-catalog/category-trees/categories#create-categories) endpoint instead.\n\nCreates a *Category*.\n\nUse this endpoint when an API only works with categories of a default BigCommerce storefront (`channel_id=1`). \n\nUse the [Create categories](/docs/rest-catalog/category-trees/categories#create-categories) endpoint when an API works with categories across different category trees that belong to different storefront channels.\n\n**Required Fields**:\n- `parent_id`: \n\t- To create a child category, set the `parent_id` to the parent category.\n\t- To create a top level category, set the `parent_id` to `0`.\n- `name`\n\n**Read-Only Fields**:\n- `id`\n\n**Limits**:\n- 16,000 categories per store limit.\n- 1,000 categories per product limit.\n- 50 characters category name length.\n- 8 levels of category depth limit.\n- 65,535 characters category description length limit.\n\n **Note:**\n The default rate limit for this endpoint is 40 concurrent requests.\n"
operationId: createCategory
parameters:
- $ref: '#/components/parameters/ContentType'
Expand Down Expand Up @@ -302,7 +302,7 @@ paths:
description: |
Custom meta description for the category page. If not defined, the storeʼs default meta description will be used.
layout_file:
maxLength: 500
maxLength: 50
minLength: 0
type: string
description: |
Expand Down
15 changes: 14 additions & 1 deletion reference/catalog/category-trees_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,13 @@ paths:
description: |-
Creates new categories.
Limits:
- 16,000 categories per store limit.
- 1,000 categories per product limit.
- 50 characters category name length.
- 8 levels of category depth limit.
- 65,535 characters category description length limit.
Creating a category requires:
- `name`
- `tree_id` or `parent_id`
Expand Down Expand Up @@ -544,6 +551,8 @@ components:
description: |
Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
example: 3
minimum: -2147483648
maximum: 2147483647
page_title:
type: string
description: |
Expand All @@ -565,7 +574,7 @@ components:
description: |
Custom meta description for the category page. If not defined, the storeʼs default meta description will be used.
layout_file:
maxLength: 500
maxLength: 50
minLength: 0
type: string
description: |
Expand All @@ -585,6 +594,8 @@ components:
type: string
description: |
A comma-separated list of keywords that can be used to locate the category when searching the store.
minLength: 0
maxLength: 255
default_product_sort:
type: string
description: |
Expand Down Expand Up @@ -895,6 +906,8 @@ components:
description: |
If not provided in POST request, the URL is autogenerated from the category name.
type: object
minLength: 1
maxLength: 255
properties:
path:
type: string
Expand Down

0 comments on commit 957328b

Please sign in to comment.