Feature/product inventory api update #94
Conversation
There was a problem hiding this comment.
@fivetran-catfritz great work on this PR! I have just a few small comments and also waiting on a final response from eng regarding one last change and testing on a connector with updates. This will be ready for approval after these small changes are provided and we can test on an up to date connector.
CHANGELOG.md
Outdated
| - `unit_cost_amount` | ||
| - `unit_cost_currency_code` |
There was a problem hiding this comment.
We should explicitly callout that these are replacing what used to be just cost. Can you be sure to call this out in the CHANGELOG.
There was a problem hiding this comment.
If that's still the case given the Height ticket and this maybe being different now.
CHANGELOG.md
Outdated
| - Additionally, new columns were added in the upstream package. For more details, see the [dbt_shopify_source v0.14.0 release notes](https://github.com/fivetran/dbt_shopify_source/releases/tag/v0.14.0). | ||
|
|
||
| ## Documentation | ||
| - Marked the following columns as deprecated in the documentation. These will be removed in a future release: |
There was a problem hiding this comment.
We should also mention that these will be null following the connector update and the customer will expect as such until we full remove them from the package.
There was a problem hiding this comment.
Thanks @fivetran-joemarkiewicz! Made the changes, and it's ready for re-review.
CHANGELOG.md
Outdated
| - `unit_cost_amount` | ||
| - `unit_cost_currency_code` |
CHANGELOG.md
Outdated
| - Additionally, new columns were added in the upstream package. For more details, see the [dbt_shopify_source v0.14.0 release notes](https://github.com/fivetran/dbt_shopify_source/releases/tag/v0.14.0). | ||
|
|
||
| ## Documentation | ||
| - Marked the following columns as deprecated in the documentation. These will be removed in a future release: |
There was a problem hiding this comment.
@fivetran-catfritz thanks for these updates! I have a few final documentation change requests, but nothing to stop the approval of this PR. I do have some requests in the source, but once that is resolve this should be good to go. Approved the transform!
CHANGELOG.md
Outdated
| ## Documentation | ||
| - Marked the following columns as deprecated in the documentation. These columns will return `null` values following the connector update, and customers should expect this behavior until the columns are fully removed in a future release. | ||
| - `shopify__inventory_levels`: | ||
| - `available_quantity` | ||
| - `is_shipping_required` | ||
| - `variant_fulfillment_service` | ||
| - `variant_grams` | ||
| - `variant_inventory_management` | ||
| - `variant_option_1` | ||
| - `variant_option_2` | ||
| - `variant_option_3` | ||
| - `variant_weight` | ||
| - `variant_weight_unit` | ||
| - `shopify__order_lines`: | ||
| - `variant_fulfillment_service` | ||
| - `variant_grams` | ||
| - `variant_inventory_management` | ||
| - `variant_option_1` | ||
| - `variant_option_2` | ||
| - `variant_option_3` | ||
| - `variant_weight` | ||
| - `variant_weight_unit` |
There was a problem hiding this comment.
These deprecated columns should be highlighted in the breaking change notes as well since they will no only populate null values. We can probably keep the same wording as you have here, but I would prefer we include this in the breaking change notes so customers make sure to be aware of these deprecations.
CHANGELOG.md
Outdated
| - `shopify__inventory_levels`: | ||
| - `cost` replaced with: | ||
| - `unit_cost_amount` | ||
| - `unit_cost_currency_code` |
There was a problem hiding this comment.
Can we actually have the cost removal be it's own entry. This way we really call attention to this as it's the only field which is being fully removed in this version. Let's make it the first entry under the breaking changes. Then we can have a section for additions and then deprecations after.
Co-authored-by: Avinash Kunnath <108772760+fivetran-avinash@users.noreply.github.com>
PR Overview
This PR will address the following Issue/Feature:
This PR will result in the following new package version:
Please provide the finalized CHANGELOG entry which details the relevant changes included in this PR:
PR Checklist
Basic Validation
Please acknowledge that you have successfully performed the following commands locally:
Before marking this PR as "ready for review" the following have been applied:
Detailed Validation
Please share any and all of your validation steps:
If you had to summarize this PR in an emoji, which would it be?
💃