-
Notifications
You must be signed in to change notification settings - Fork 26
feat: Android SDK update for version 11.1.0 #92
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
WalkthroughThe SDK is updated to version 11.0.1, including a header bump and README dependency version updates. The Account service introduces createEmailVerification and updateEmailVerification, while deprecating createVerification and updateVerification; email and phone verification endpoints are migrated to new /account/verifications/* paths. New Java and Kotlin examples demonstrate creating and updating email verifications. Documentation is adjusted accordingly, including TablesDb comment updates to reference revised server/cloud paths. No runtime logic changes outside the new methods and endpoint path updates are indicated. Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CHANGELOG.md (1)
3-7: Complete the changelog entries.The changelog mentions the deprecation of
createVerificationand addition ofcreateEmailVerification, but it should also document:
- Addition of
updateEmailVerificationmethod- Deprecation of
updateVerificationmethodApply this diff to complete the changelog:
## 11.0.1 * Deprecate `createVerification` method in `Account` service * Add `createEmailVerification` method in `Account` service +* Deprecate `updateVerification` method in `Account` service +* Add `updateEmailVerification` method in `Account` service
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
CHANGELOG.md(1 hunks)README.md(2 hunks)docs/examples/java/account/create-email-verification.md(1 hunks)docs/examples/java/account/update-email-verification.md(1 hunks)docs/examples/kotlin/account/create-email-verification.md(1 hunks)docs/examples/kotlin/account/update-email-verification.md(1 hunks)library/src/main/java/io/appwrite/Client.kt(1 hunks)library/src/main/java/io/appwrite/services/Account.kt(4 hunks)library/src/main/java/io/appwrite/services/TablesDb.kt(9 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/examples/kotlin/account/create-email-verification.md
12-12: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (11)
library/src/main/java/io/appwrite/Client.kt (1)
90-90: LGTM! Version bump aligns with the release.The SDK version header is correctly updated to 11.0.1, matching the PR objectives.
library/src/main/java/io/appwrite/services/Account.kt (5)
2032-2055: LGTM! Clean implementation of the new email verification endpoint.The new
createEmailVerificationmethod follows the established patterns in the Account service and correctly targets the new/account/verifications/emailendpoint.
2067-2094: LGTM! Proper deprecation with backward compatibility.The deprecated
createVerificationmethod correctly:
- Includes a clear deprecation message pointing to the replacement method
- Uses the updated endpoint path
/account/verifications/email- Maintains backward compatibility by preserving the method signature
This ensures existing code continues to work while guiding developers to the new API.
2104-2129: LGTM! New method aligns with the updated API surface.The
updateEmailVerificationmethod is well-implemented and targets the correct endpoint.
2139-2168: LGTM! Consistent deprecation pattern.The
updateVerificationdeprecation follows the same pattern ascreateVerification, providing a smooth migration path.
2178-2178: LGTM! Phone verification paths updated consistently.The phone verification methods now use
/account/verifications/phone, maintaining consistency with the email verification path structure.Also applies to: 2211-2211
README.md (1)
41-41: LGTM! Dependency versions updated correctly.Both Gradle and Maven dependency examples are updated to version 11.0.1, ensuring consistency across the documentation.
Also applies to: 52-52
docs/examples/java/account/update-email-verification.md (1)
1-23: LGTM! Clear and correct Java example.The example demonstrates proper usage of the new
updateEmailVerificationmethod with appropriate error handling viaCoroutineCallback.docs/examples/kotlin/account/update-email-verification.md (1)
1-14: LGTM! Idiomatic Kotlin example.The example correctly demonstrates the suspend function usage with named parameters, which is the idiomatic approach for Kotlin.
docs/examples/java/account/create-email-verification.md (1)
1-22: LGTM! Clear Java usage example.The example properly demonstrates the new
createEmailVerificationmethod with appropriate async handling.docs/examples/kotlin/account/create-email-verification.md (1)
1-13: LGTM! Correct Kotlin example.The example correctly demonstrates the suspend function usage for
createEmailVerification.Note: The static analysis warning about the bare URL on line 12 is a false positive—it's a legitimate example showing the URL parameter value.
This PR contains updates to the Android SDK for version 11.1.0.