Clarify what format the country is on phone number inputs

Fixes https://github.com/matrix-org/matrix-doc/issues/1982
This commit is contained in:
Travis Ralston 2019-11-04 15:25:49 -07:00
parent ae163ab818
commit 284b15495b
3 changed files with 6 additions and 2 deletions

View file

@ -30,8 +30,8 @@ properties:
country:
type: string
description: |-
The two-letter uppercase ISO country code that the number in
``phone_number`` should be parsed as if it were dialled from.
The two-letter uppercase ISO-3166-1 alpha-2 country code that the
number in ``phone_number`` should be parsed as if it were dialled from.
example: "GB"
phone_number:
type: string

View file

@ -0,0 +1 @@
Clarify the expected phone number format.

View file

@ -1042,6 +1042,9 @@ wishes to canonicalise the phone number, then it can use the
"phone": "<The phone number>"
}
The ``country`` is the two-letter uppercase ISO-3166-1 alpha-2 country code
that the number in ``phone`` should be parsed as if it were dialled from.
Login
~~~~~