8000 Rename verification SDK methods to be more specific by ChiragAgg5k · Pull Request #10606 · appwrite/appwrite · GitHub
[go: up one dir, main page]

Skip to content

Conversation

@ChiragAgg5k
Copy link
Member

Summary

  • Renames createVerification to createEmailVerification
  • Renames updateVerification to updateEmailVerification
  • Maintains backwards compatibility by keeping old method names as deprecated (since 1.8.0)
  • Updates SDK method definitions to use array syntax with both new and deprecated methods

Changes

The verification SDK methods have been updated to better reflect their purpose as email verification methods:

Create Email Verification

  • New method: account.createEmailVerification
  • Deprecated method: account.createVerification (deprecated since 1.8.0)

Update Email Verification

  • New method: account.updateEmailVerification
  • Deprecated method: account.updateVerification (deprecated since 1.8.0)

Implementation Details

  • Both endpoints now use an array of Method objects in their SDK label
  • The first method in each array is the new, preferred method name
  • The second method is the deprecated old name with a Deprecated object indicating replacement
  • All OpenAPI/Swagger specs have been automatically updated to reflect these changes

Test plan

  • Verify SDK generation includes both new and deprecated methods
  • Confirm deprecated methods show proper deprecation warnings
  • Test that both old and new method names work correctly
  • Validate OpenAPI/Swagger spec changes are correct

🤖 Generated with Claude Code

This commit renames the verification SDK methods to better reflect their purpose:
- `createVerification` → `createEmailVerification`
- `updateVerification` → `updateEmailVerification`

The old method names are maintained for backwards compatibility and marked as deprecated (since 1.8.0) with references to the new method names.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@coderabbitai
Copy link
Contributor
coderabbitai bot commented Oct 6, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (12)
  • app/config/specs/open-api3-1.8.x-client.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-1.8.x-console.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-1.8.x-server.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-latest-client.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-latest-console.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-latest-server.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-1.8.x-client.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-1.8.x-console.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-1.8.x-server.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-latest-client.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-latest-console.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-latest-server.json is excluded by !app/config/specs/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Replaced single SDK Method entries with arrays for account verification endpoints in app/controllers/api/account.php. Introduced new primary methods createEmailVerification/updateEmailVerification and createPhoneVerification/updatePhoneVerification on new paths /v1/account/verifications/email and /v1/account/verifications/phone, and retained the original names (createVerification/updateVerification and phone variants) as deprecated Method entries that point to the new replacements. Each new verifications path also registers an alias to the original /v1/account/verification(*/phone) paths. Authentication, response models, and content types are unchanged.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • loks0n
  • ItzNotABug

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly and concisely summarizes the primary change of renaming the SDK verification methods to more specific names, accurately reflecting the main update in the changeset.
Description Check ✅ Passed The description is directly related to the changeset, detailing the renaming of methods, deprecation strategy, SDK array syntax, and test plan, which makes it sufficiently informative and on-topic.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link
pkg-pr-new bot commented Oct 6, 2025

Open in StackBlitz

npm i https://pkg.pr.new/appwrite/appwrite/@appwrite.io/console@10606

commit: 8baf4d4

@github-actions
Copy link
github-actions bot commented Oct 6, 2025

Security Scan Results for PR

Docker Image Scan Results

Package Version Vulnerability Severity
binutils 2.44-r2 CVE-2025-5244 HIGH
binutils 2.44-r2 CVE-2025-5245 HIGH
libexpat 2.7.1-r0 CVE-2025-59375 HIGH
golang.org/x/crypto v0.31.0 CVE-2025-22869 HIGH
golang.org/x/oauth2 v0.24.0 CVE-2025-22868 HIGH
stdlib 1.22.10 CVE-2025-47907 HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

@github-actions
Copy link
github-actions bot commented Oct 6, 2025

✨ Benchmark results

  • Requests per second: 1,259
  • Requests with 200 status code: 226,592
  • P99 latency: 0.154781473

⚡ Benchmark Comparison

Metric This PR Latest version
RPS 1,259 1,018
200 226,592 183,264
P99 0.154781473 0.191451855

Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 56076ad and 024d13c.

⛔ Files ignored due to path filters (12)
  • app/config/specs/open-api3-1.8.x-client.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-1.8.x-console.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-1.8.x-server.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-latest-client.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-latest-console.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-latest-server.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-1.8.x-client.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-1.8.x-console.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-1.8.x-server.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-latest-client.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-latest-console.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-latest-server.json is excluded by !app/config/specs/**
📒 Files selected for processing (1)
  • app/controllers/api/account.php (4 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
app/controllers/api/account.php (2)
src/Appwrite/SDK/Method.php (1)
  • Method (9-314)
src/Appwrite/SDK/Deprecated.php (1)
  • Deprecated (5-32)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)
  • GitHub Check: E2E Service Test (Messaging)
  • GitHub Check: E2E Service Test (Migrations)
  • GitHub Check: E2E Service Test (Webhooks)
  • GitHub Check: E2E Service Test (Users)
  • GitHub Check: E2E Service Test (Tokens)
  • GitHub Check: E2E Service Test (Realtime)
  • GitHub Check: E2E Service Test (Storage)
  • GitHub Check: E2E Service Test (Proxy)
  • GitHub Check: E2E Service Test (Account)
  • GitHub Check: E2E Service Test (Locale)
  • GitHub Check: E2E Service Test (Functions)
  • GitHub Check: E2E Service Test (Databases/TablesDB)
  • GitHub Check: E2E Service Test (Avatars)
  • GitHub Check: E2E Service Test (Databases/Legacy)
  • GitHub Check: E2E Service Test (Site Screenshots)
  • GitHub Check: E2E Service Test (Dev Keys)
  • GitHub Check: E2E General Test
  • GitHub Check: Unit Test
  • GitHub Check: Setup & Build SDK
  • GitHub Check: scan

@abnegate abnegate merged commit 92ecd08 into 1.8.x Oct 7, 2025
43 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Oct 7, 2025
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Oct 16, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

0