From 286f174f3453d06c073b9c3436e78ed81eb4b676 Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Tue, 14 Jun 2022 09:27:27 +0200 Subject: [PATCH] fix: docs --- app/controllers/api/account.php | 4 ++-- src/Appwrite/Utopia/Response/Model/User.php | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index dfb4b3b959..682c1a3934 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -842,7 +842,7 @@ App::post('/v1/account/sessions/phone') ->label('abuse-limit', 10) ->label('abuse-key', 'url:{url},email:{param-email}') ->param('userId', '', new CustomId(), 'Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.') - ->param('number', '', new ValidatorPhone(), 'Phone number.') + ->param('number', '', new ValidatorPhone(), 'Phone number. Format this number with a leading \'+\' and a country code, e.g., +16175551212.') ->inject('request') ->inject('response') ->inject('project') @@ -1560,7 +1560,7 @@ App::patch('/v1/account/phone') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_USER) - ->param('number', '', new ValidatorPhone(), 'Phone number.') + ->param('number', '', new ValidatorPhone(), 'Phone number. Format this number with a leading \'+\' and a country code, e.g., +16175551212.') ->param('password', '', new Password(), 'User password. Must be at least 8 chars.') ->inject('response') ->inject('user') diff --git a/src/Appwrite/Utopia/Response/Model/User.php b/src/Appwrite/Utopia/Response/Model/User.php index 1ad0fe6c32..9901d055d8 100644 --- a/src/Appwrite/Utopia/Response/Model/User.php +++ b/src/Appwrite/Utopia/Response/Model/User.php @@ -49,7 +49,7 @@ class User extends Model ]) ->addRule('phone', [ 'type' => self::TYPE_STRING, - 'description' => 'User phone number.', + 'description' => 'User phone number in E.164 format.', 'default' => '', 'example' => '+4930901820', ])