Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify what format the country is on phone number inputs #2342

Merged
merged 1 commit into from
Nov 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api/identity/definitions/request_msisdn_validation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2342.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify the expected phone number format.
3 changes: 3 additions & 0 deletions specification/client_server_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~

Expand Down