-
Notifications
You must be signed in to change notification settings - Fork 38
Add content to upgrade guide for v6 major bump #208
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
751af58
to
9abf638
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd argue we need the following items in the upgrade guide too:
- Changes the type
result
of Event fromEasyPostResource
toMap<String, Object>
- Changes the type of Insurance
Amount
from Float to String - Removes all the setters of each object (we say setters are available via lombok; however, I don't think we added the decorator meaning users can't access them. In the off chance someone was previously, we need to call it out that they can't any longer)
- Rename some getters
- Pickup class:
getPickoutRates()
->getPickupRates()
- PaymentMethod class:
getPrimaryPaymentMethodObject()
->getPrimaryPaymentMethod()
- PaymentMethod class:
getSecondaryPaymentMethodObject()
->getSecondaryPaymentMethod()
- Pickup class:
The point of the upgrade guide is to callout anything that will require a user to change their code and provide guidance and examples on how to do it to ease the process of moving from one major version to another. We don't need to call out additions here (the CHANGELOG can handle that), but the upgrade guide should include anything substantial that will require an engineer to make a tweak in a codebase downstream from us.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Various small nits to fix grammar/spelling
3f57b66
to
0cdc3b1
Compare
Description
Add content for the V6 major bump in the upgrade guide
Move the
ExternalApiError
from the general to API folderTesting
N/A
Pull Request Type
Please select the option(s) that are relevant to this PR.