Remove RequestOptions.setStripeVersionOverride
#1464
Merged
Conversation
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
richardm-stripe
changed the title
richardm-stripe
force-pushed
the
richardm-curb-version-overrides
branch
from
e5083f8 to
cde1e79
Compare
richardm-stripe
changed the title
Contributor
Author
|
Assigned you @pakrym-stripe as you are the "reporter" on our internal ticket for this ;) |
| * @return option builder | ||
| */ | ||
| public RequestOptionsBuilder setStripeVersionOverride(String stripeVersionOverride) { | ||
| public RequestOptionsBuilder _setStripeVersionOverride(String stripeVersionOverride) { |
Contributor
There was a problem hiding this comment.
can we make this a static method so it doesn't show up in IDE code completion. And maybe name it unsafeSetStripeVersionOverride?
pakrym-stripe
approved these changes
Oct 31, 2022
Contributor
pakrym-stripe
left a comment
pakrym-stripe
left a comment
There was a problem hiding this comment.
LGTM overall. Wonder if we can hide _setStripeVersionOverride in a way that doesn't pollute code completion.
pakrym-stripe
approved these changes
Nov 4, 2022
Contributor
pakrym-stripe
left a comment
pakrym-stripe
left a comment
There was a problem hiding this comment.
One nit, let's hide the getVersionOverride
Co-authored-by: pakrym-stripe <[email protected]>
richardm-stripe
changed the title
RequestOptions.setStripeVersionOverride
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.
Notify
cc @stripe/api-library-reviewers
Summary
This PR removes
RequestOptions.setStripeVersionOverride. There was only one supported use case forsetStripeVersionOverride, forEphemeralKey.create. Now, users shouldto set the
Stripe-Versionheader appropriately.We introduce
RequestOptions.unsafeSetStripeVersionOverridewhich is marked as internal only.Because
com.stripe.model.EphemeralKeyis not in thecom.stripe.netpackage, we can't actually change make this internal-only method private, but users should not use it.Changelog
StripeVersionas a required value onEphemeralKeyCreateParams.EphemeralKey.createwithout specifyingRequestOptions.RequestOptions.setStripeVersionOverrideis renamed tounsafeStripeVersionOverrideto confront upgrading users with the fact that this is now internal-only and should not be used. The docs now indicate it is internal-only. It is also now a static method, to prevent it from polluting IDE autocomplete list.RequestOptions.getStripeVersionOverrideis similarly changed tounsafeGetStripeVersionOverride.RequestOptions.clearStripeVersionOverrideis removed entirely. There is no reason to use this.RequestOptions.toBuilderis now marked as deprecated, in favor oftoBuilderFullCopy, which has clearer semantics.