Skip to content

docs: @phone and isPhone#610

Open
sanny-io wants to merge 1 commit into
zenstackhq:mainfrom
sanny-io:docs/phone
Open

docs: @phone and isPhone#610
sanny-io wants to merge 1 commit into
zenstackhq:mainfrom
sanny-io:docs/phone

Conversation

@sanny-io
Copy link
Copy Markdown
Contributor

@sanny-io sanny-io commented May 26, 2026

Summary by CodeRabbit

  • Documentation
    • Updated ZModel input validation reference documentation with new @phone attribute for string field validation, supporting E.164 phone number format
    • Added documentation for isPhone() helper utility function to programmatically validate E.164 phone numbers on string fields

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

@sanny-io is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e609bdc4-77bf-4307-afe3-1713e36a5cc6

📥 Commits

Reviewing files that changed from the base of the PR and between 69129cc and a425d24.

📒 Files selected for processing (1)
  • docs/reference/zmodel/input-validation.md

Walkthrough

Documentation for phone number validation support was added to the ZModel input validation reference. The @phone field attribute and isPhone() helper function are now documented for validating E.164 phone numbers.

Changes

Phone number validation documentation

Layer / File(s) Summary
Phone validation attribute and helper function documentation
docs/reference/zmodel/input-validation.md
Added documentation for the @phone field-level attribute with optional message parameter and the isPhone() helper function for validating E.164 phone numbers.

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly and concisely summarizes the main change: documentation for two new validation features (@phone attribute and isPhone function).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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.

1 participant