SAC-31563 Updated Schemas - #29
Open
rsaha-qlik wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates Singer JSON schemas for the BigCommerce tap to better reflect nullable API fields and fix downstream loading issues with target-snowflake (per SAC-31565).
Changes:
- Allow
nullfor several array-typed fields inproducts(e.g.,categories,related_products,bulk_pricing_rules). - Correct
products.custom_fieldsto be a nullable array of objects (instead of an object). - Allow
nullfor nested objects that can be absent/empty in payloads (orders.billing_address,coupons.applies_to).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tap_bigcommerce/schemas/products.json | Makes selected arrays nullable and fixes custom_fields to a nullable array of objects. |
| tap_bigcommerce/schemas/orders.json | Allows billing_address to be null while keeping the object shape. |
| tap_bigcommerce/schemas/coupons.json | Allows applies_to to be null while keeping the object shape. |
rsaha-qlik
commented
Jul 10, 2026
| }, | ||
| "id": { | ||
| "$ref": "type-integer.json" | ||
| "type": ["array", "null"], |
Author
There was a problem hiding this comment.
Updated this wrt the doc: https://docs.bigcommerce.com/developer/api-reference/rest/admin/catalog/products/get-products
RushiT0122
approved these changes
Jul 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of change
https://qlik-dev.atlassian.net/browse/SAC-31565
This PR includes schema changes that may require downstream updates and is released as v2.0.0.
What changed
products.custom_fieldsis now strictly typed as["array", "null"]with object items (name,value,id).nullto match API behavior:products.categoriesproducts.related_productscoupons.applies_toorders.billing_addressproducts.bulk_pricing_rulesWhy this is breaking
products.custom_fields(for example, object/non-array handling) may fail validation or transformation after upgrade.Action required
products.custom_fieldsand ensure they handle only array-or-null.Manual QA steps
Risks
Rollback steps
AI generated code
https://internal.qlik.dev/general/ways-of-working/code-reviews/#guidelines-for-ai-generated-code