Add public visibility control for deprecated methods#10933
Merged
ChiragAgg5k merged 1 commit into1.8.xfrom Dec 11, 2025
Merged
Conversation
- Add 'public' parameter to SDK Method class to control documentation visibility - Mark deprecated methods as non-public (public: false) to hide them from docs - Update OpenAPI and Swagger specs to reflect visibility changes - Affected endpoints: account verification, messaging providers, and MFA authenticators
Contributor
|
Caution Review failedFailed to post review comments 📝 WalkthroughWalkthroughThis pull request implements a comprehensive authentication and API infrastructure refactoring. The primary changes include: migrating the authorization system from static Auth class methods to User document-based checks; introducing nullable parameter wrappers and includeTotal flags across multiple API list endpoints; updating database collections with new attributes (emailCanonical, emailIsCanonical, emailIsFree, emailIsDisposable, emailIsCorporate, transformations); adding support for password/token proofs and store-based session management; implementing dark-mode support in email templates; introducing TanStack Start framework support; adding new logging configuration for realtime operations; and updating numerous dependency versions in composer.json. Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Areas requiring extra attention:
Possibly related PRs
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 |
commit: |
Security Scan Results for PRDocker Image Scan Results
Source Code Scan Results🎉 No vulnerabilities found! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a visibility control mechanism for deprecated API methods to hide them from public documentation while maintaining backward compatibility. The implementation adds a public parameter to the Method class and systematically marks deprecated methods across account verification, MFA, messaging providers, and project configuration endpoints as non-public.
Key Changes
- Added
publicproperty with getter/setter methods to theMethodclass (defaults totrue) - Updated OpenAPI 3 and Swagger 2 specification generators to include the
publicfield at both SDK and method levels - Marked 30+ deprecated methods as non-public (
public: false) across account, messaging, projects, and users modules - Updated specification JSON files to reflect the visibility changes for all endpoints
Reviewed changes
Copilot reviewed 19 out of 27 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Appwrite/SDK/Method.php | Adds public property with default value true, plus isPublic() and setPublic() methods |
| src/Appwrite/SDK/Specification/Format/OpenAPI3.php | Adds public field to SDK info and method metadata in parsed specification |
| src/Appwrite/SDK/Specification/Format/Swagger2.php | Adds public field to SDK info and method metadata in parsed specification |
| src/Appwrite/Platform/Modules/Account/Http/Account/MFA/* | Marks deprecated MFA authenticators, challenges, factors, and recovery codes as non-public |
| app/controllers/api/account.php | Marks deprecated account verification endpoints as non-public |
| app/controllers/api/messaging.php | Marks deprecated SMTP, FCM, APNS provider and SMS endpoints as non-public |
| app/controllers/api/projects.php | Marks deprecated API status and SMTP/SMS template endpoints as non-public |
| app/controllers/api/users.php | Marks deprecated user MFA endpoints as non-public |
| app/config/specs/swagger2-latest-server.json | Updates specification with public fields for all methods and deprecated method visibility |
| app/config/specs/swagger2-latest-console.json | Updates specification with public fields for all methods and deprecated method visibility |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
✨ Benchmark results
⚡ Benchmark Comparison
|
loks0n
approved these changes
Dec 11, 2025
This was referenced Dec 11, 2025
Closed
Merged
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
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.
Summary
This PR adds a visibility control mechanism for deprecated methods to prevent them from appearing in public documentation while maintaining backward compatibility in the API.
Changes
publicparameter to theMethodclass to control documentation visibilityisPublic()andsetPublic()methods to the Method classpublic: false) across:Test plan