Fix docs on getting stripe object from EventDataObjectDeserializer
#727
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
more fix
mickjermsurawong-stripe
force-pushed
the
mickjermsurawong/fix-more-docs
branch
from
b24289d to
e802226
Compare
| * concrete class for abstract {@code StripeObject}) schema. This is when | ||
| * {@link Event#getApiVersion()} matches {@link Stripe#API_VERSION}. | ||
| * @return stripe object that fully represent its original raw JSON response. | ||
| * Gets optional of data event object, in favor of the deprecated {@link EventData#getObject()}. |
Contributor
There was a problem hiding this comment.
I'd explicitly indicate that "optional" here refers to the type Optional<T> because otherwise the the grammar doesn't make sense.
Contributor
There was a problem hiding this comment.
==. Maybe {@link java.util.Optional} would work? Otherwise {@code Optional<T>} is probably explicit enough too.
Contributor
Author
|
thank you brandur! I made the changes. |
mickjermsurawong-stripe
changed the title
EventDataObjectDeserializer
| * concrete class for abstract {@code StripeObject}) schema. This is when | ||
| * {@link Event#getApiVersion()} matches {@link Stripe#API_VERSION}. | ||
| * @return stripe object that fully represent its original raw JSON response. | ||
| * Gets an option of data event object, in favor of the deprecated {@link EventData#getObject()}. |
Contributor
Contributor
Contributor
Author
|
Addressed the feedback! |
Contributor
|
@mickjermsurawong-stripe Ah, I meant the "option" on this line specifically in the description:
|
Contributor
Author
|
whoops sorry I misunderstood.. |
brandur-stripe
approved these changes
Apr 9, 2019
Contributor
Author
|
thank you Brandur! |
mickjermsurawong-stripe
pushed a commit
that referenced
this pull request
Apr 9, 2019
* Drop support for Java 1.7 * Upgrade dev dependencies (except JUnit) * Upgrade to JUnit 5 * Use ErrorProne in builds * Return unsafe deserialized event data object as Option (#723) * return as option * update doc * Autogen params (#705) * test: typed param setup - fix ambiguous call with null casting test: CardTest ambiguous call with typed param * Basic primitives for typed params (#679) * extract common deserializer method extract common logic * implement ApiParamRequest add api param request * Add to base test lenient request params comparison for list/array int/long comparison * use List<Object> instead of Object[] in untyped deserializer * provide documentation to deserializer and api request param * reorder import statments * fix other imports in new files * test: Standardization consider request param as map param * rename and add more test (#718) * Fix remaining ErrorProne warnings * Verify deserialized boolean params to map (#722) * verify boolean behavior * add suppress warning * Generated for V9.0 [generated] source: spec3.sdk.yaml@non-master-spec-fb07de8 in mickjer… (#711) * test: typed params path query expand and limit * test: typed params on methods previously had params as string constant * test: typed params on polymoprhic of EMPTY and array test: use new empty param * test: typed params on inner object * test: typed params by collection methods * test: typed param fix to singular * test: typed param create token with different instruments test: Token with ObjectType enum test: typed params create token * test: typed params create charge test: typed params charge * generated: param * generated: model * generated: param * [generated] source: spec3.sdk.yaml@non-master-spec-d9e92b9 in mickjermsurawong/working-autogen * [ErrorProne fix: add @OverRide to enum get value][generated] source: spec3.sdk.yaml@non-master-spec-d9e92b9 in mickjermsurawong/working-autogen * [Rename Number to card details][generated] source: spec3.sdk.yaml@non-master-spec-c5dbddd in mickjermsurawong/working-autogen * [Sort setter methods][generated] source: spec3.sdk.yaml@non-master-spec-97a62f7 in gen-param-default * test: remove getters from params * test: create webhook with event enums * test: typed param addAll/putAll * [generated] source: spec3.sdk.yaml@non-master-spec-6e9fab7 in mickjermsurawong/default-gen-param * Update doc on previous attributes array representation (#726) * update doc about array representation * fix another typo * Another dependency version bump * Fix docs on getting stripe object from `EventDataObjectDeserializer` (#727) * update docs on get object * Add missing Javadoc * Add non-autogen typed params Event/File/EphemeralKeys (#730) * file create params with handling of file object * create file with typed params * list file with typed params update import order on files refactor file test * add ephemeral key create params * add event list params * null check for typed parameters
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.
r? @ob-stripe