Skip to content
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

[TW-573] Document Android POS SDK example responses #241

Merged

Conversation

kimberleehowley
Copy link
Contributor

What

This PR adds the example success schemas to the relevant POS SDK methods.

Note that I debated including a concrete response instead of the schema, but ultimately I decided to go with the industry standard pattern of the schema. Please Slack me with any questions!

Why

This could spare customers the trouble of digging in the codebase for the schema.

Test Plan

  • ❌ | Unit tests aren't relevant for comment-only changes.
  • ✅ | ❌ The reviewer should manually test the changes in this PR:
./gradlew dokkaHtml
npx http-serve reference-docs

@kimberleehowley kimberleehowley added the documentation Improvements or additions to documentation label Apr 8, 2024
@kimberleehowley kimberleehowley self-assigned this Apr 8, 2024
Copy link
Contributor

@djoksimo djoksimo left a comment

Choose a reason for hiding this comment

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

Copy link
Contributor

@djoksimo djoksimo left a comment

Choose a reason for hiding this comment

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

Thank you incorporating this change @kimberleehowley! I know Github links are not ideal, as you said, but we'll come up with a better workaround soon!

* On failure, the response includes a list of
* [ForageError][com.joinforage.forage.android.network.model.ForageError] objects that you can
* unpack to troubleshoot the issue.
* PIN capture.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: This was present before, but can we change (in this/future PR) all instances of PIN capture to say "secure PIN submission" or something alike

Given that capture is used in the context of "payment capture"

@kimberleehowley kimberleehowley merged commit 6d76273 into main Apr 12, 2024
6 checks passed
@kimberleehowley kimberleehowley deleted the kimberlee/tw-573-document-android-sdk-example-responses branch April 12, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants