Skip to content

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Sep 16, 2025

Problem

The ?include parameter for the Get All Products endpoint supports a variants value that was not documented in the OpenAPI schema. This creates inconsistency between the actual API behavior and the documentation.

Solution

Added variants to the IncludeParamBase schema enum in reference/catalog/products_catalog.v3.yml. This parameter schema is used by three endpoints:

  • GET /catalog/products (Get All Products)
  • GET /catalog/products/{product_id} (Get a Product)
  • PUT /catalog/products/{product_id} (Update a Product)

Context

The variants value was already:

  • Supported by the API implementation
  • Included in the response schemas (productVariant_Full)
  • Documented in a different parameter (include_fields)

This change brings the include parameter documentation in line with the actual API behavior and makes it consistent with the existing include_fields parameter.

Testing

  • ✅ OpenAPI spec validation passes (Spectral)
  • ✅ MDX linting passes
  • ✅ No breaking changes to existing functionality

Fixes the documentation gap identified in the original issue where variants was a supported but undocumented value for the include parameter.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits September 16, 2025 16:35
…cumentation

Co-authored-by: bookernath <8922457+bookernath@users.noreply.github.com>
…endpoint

Co-authored-by: bookernath <8922457+bookernath@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] https://developer.bigcommerce.com/docs/rest-catalog/products#get-all-products:~:text=array%5Binteger%5D-,include,-in - Get All Products - The ?include parameter supports a variants value that is not documented here - please add this to the schema that ... Add variants to include parameter documentation for Products endpoints Sep 16, 2025
@Copilot Copilot AI requested a review from bookernath September 16, 2025 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants