Add variants to include parameter documentation for Products endpoints #1082
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The
?include
parameter for the Get All Products endpoint supports avariants
value that was not documented in the OpenAPI schema. This creates inconsistency between the actual API behavior and the documentation.Solution
Added
variants
to theIncludeParamBase
schema enum inreference/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:productVariant_Full
)include_fields
)This change brings the
include
parameter documentation in line with the actual API behavior and makes it consistent with the existinginclude_fields
parameter.Testing
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.