Merge pull request #2342 from matrix-org/travis/spec/fix-1982

Clarify what format the `country` is on phone number inputs
matrix-org · Nov 5, 2019 · a50e828 · a50e828
2 parents a85d72a + 284b154
commit a50e828
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/api/identity/definitions/request_msisdn_validation.yaml b/api/identity/definitions/request_msisdn_validation.yaml
@@ -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

diff --git a/changelogs/client_server/newsfragments/2342.clarification b/changelogs/client_server/newsfragments/2342.clarification
@@ -0,0 +1 @@
+Clarify the expected phone number format.
diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst
@@ -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
 ~~~~~