Skip to content

Conversation

@venalen
Copy link
Contributor

@venalen venalen commented Mar 24, 2023

What

API version 2.1.0. See https://docs.patch.io/#/changelog for changes

Why

Version 2.1.0 adds support for

  • vintage_start_year and vintage_end_year for orders
  • vintage_start_year and vintage_end_year for order line items
  • vintage_start_year and vintage_end_year for inventory
  • carrier_scac field to Patch::Estimate.create_road_shipping_estimat

SDK Release Checklist

  • Have you added an integration test for the changes?
  • Have you built the library locally and made queries against it successfully?
  • Did you update the changelog?
  • Did you bump the package version?
  • If endpoints were removed, did you manually remove the corresponding files? (this should be rare)
  • For breaking changes, did you plan for the release of the new SDK versions and deploy the API to production?

@venalen venalen force-pushed the venalen/ruby-sdk-2.1.0 branch 5 times, most recently from 309814c to 4c3fe36 Compare March 25, 2023 20:02
@venalen venalen marked this pull request as ready for review March 27, 2023 15:43
@venalen venalen requested a review from a team March 27, 2023 15:44
Copy link
Contributor

@pcothenet pcothenet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work. One concern about the OpenAPI version comment that looks manual and not desired.

@venalen venalen force-pushed the venalen/ruby-sdk-2.1.0 branch from 4c3fe36 to 11b4ec7 Compare March 27, 2023 16:57
Copy link
Contributor

@holtbp holtbp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sharing some thoughts that feel very late

@venalen
Copy link
Contributor Author

venalen commented Mar 27, 2023

Those are some great thoughts! We should definitely go over what we want the response to look like in the case of vintage years for v3, but I would think that either having a top-level vintage_start_year and vintage_end_year or a vintage object with start_year and end_year would suffice. I would think having a stable response that doesn't change regardless of a single year or a range would be easier to consume. Happy to discuss further when the time comes!

In the meantime, should we remove "deprecated" tags since we'll still have support for these fields?

@holtbp
Copy link
Contributor

holtbp commented Mar 27, 2023

In the meantime, should we remove "deprecated" tags since we'll still have support for these fields?

Yeah, that sounds good.

@venalen venalen force-pushed the venalen/ruby-sdk-2.1.0 branch 5 times, most recently from 8f1e9a4 to 3408064 Compare April 4, 2023 21:10
)

expect(create_estimate_response.data.type).to eq 'shipping'
expect(create_estimate_response.data.type).to eq 'ecommerce'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're now re-routing to the ecommerce endpoint: https://github.com/patch-technology/patch/pull/5588

@venalen venalen force-pushed the venalen/ruby-sdk-2.1.0 branch from 3408064 to 4353f65 Compare April 4, 2023 21:13
@venalen venalen requested a review from a team April 4, 2023 21:17
Copy link
Contributor

@holtbp holtbp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mind if we bundle this change in with 2.1.0?
#75

CHANGELOG.md Outdated
### Added

- Adds optional `vintage_start_year` and `vintage_end_year` field to `order` creation
- Adds optional `vintage_start_year` and `vintage_end_year` field to `order_line_item` create and update
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Super nit]: "fields" 😃

@venalen venalen force-pushed the venalen/ruby-sdk-2.1.0 branch from 4353f65 to 8b5243d Compare April 4, 2023 21:56
- Adds `vintage_start_year` and `vintage_end_year` fields to `order` response
- Adds `vintage_start_year` and `vintage_end_year` fields to `order_line_item` response
- Adds optional `carrier_scac` field to `Patch::Estimate.create_road_shipping_estimate` method
- Deprecates `Patch::Estimate.create_shipping_estimate` in favor of `Patch::Estimate.create_ecommerce_estimate`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that there doesn't seem to be a related change in the code. Is it just behind the scenes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it's in relation to https://github.com/patch-technology/patch/pull/5588. @holtbp merged his change that fixes the integration tests and we spoke offline on updating the docs

@venalen venalen merged commit 9f8b01e into main Apr 4, 2023
@venalen venalen deleted the venalen/ruby-sdk-2.1.0 branch April 4, 2023 22:06
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.

5 participants