jarno
/
element-android
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve wording and fix typo

This commit is contained in:
Benoit Marty 2020-09-04 14:23:56 +02:00
parent 2490d4d638
commit 82e3adebbc
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/signup.md
View File

@ -137,7 +137,7 @@ We get a 400:
### Step 2: entering email ### Step 2: entering email
User is proposed to enter an email. We skip this step. User is proposed to enter an email. User skips this step.
```shell script ```shell script
curl -X POST --data $'{"auth":{"session":"xptUYoREDACTEDogOWAGVnbJQ","type":"m.login.dummy"}}' 'https://matrix.org/_matrix/client/r0/register' curl -X POST --data $'{"auth":{"session":"xptUYoREDACTEDogOWAGVnbJQ","type":"m.login.dummy"}}' 'https://matrix.org/_matrix/client/r0/register'
@ -195,7 +195,7 @@ curl -X POST --data $'{"auth":{"session":"xptUYoREDACTEDogOWAGVnbJQ","type":"m.l
} }
``` ```
### Step 2 bis: we enter an email ### Step 2 bis: user enters an email
We request a token to the homeserver. The `client_secret` is generated by the application We request a token to the homeserver. The `client_secret` is generated by the application
@ -266,7 +266,7 @@ curl -X POST --data $'{"auth":{"threepid_creds":{"client_secret":"53e679ea-oRED-
} }
``` ```
We click on the link received by email `https://matrix.org/_matrix/client/unstable/registration/email/submit_token?token=vtQjQIZfwdoREDACTEDozrmKYSWlCXsJ&client_secret=53e679ea-oRED-ACTED-92b8-3012c49c6cfa&sid=qlBCREDACTEDEtgxD` which contains: User clicks on the link received by email `https://matrix.org/_matrix/client/unstable/registration/email/submit_token?token=vtQjQIZfwdoREDACTEDozrmKYSWlCXsJ&client_secret=53e679ea-oRED-ACTED-92b8-3012c49c6cfa&sid=qlBCREDACTEDEtgxD` which contains:
- A `token` vtQjQIZfwdoREDACTEDozrmKYSWlCXsJ - A `token` vtQjQIZfwdoREDACTEDozrmKYSWlCXsJ
- The `client_secret`: 53e679ea-oRED-ACTED-92b8-3012c49c6cfa - The `client_secret`: 53e679ea-oRED-ACTED-92b8-3012c49c6cfa
- A `sid`: qlBCREDACTEDEtgxD - A `sid`: qlBCREDACTEDEtgxD
@ -412,7 +412,7 @@ Some homeservers may require the user to enter MSISDN.
On matrix.org, it's not required, and not even optional, but it's still possible for the app to add a MSISDN during the registration. On matrix.org, it's not required, and not even optional, but it's still possible for the app to add a MSISDN during the registration.
The user enter a phone number and select a country, the `client_secret` is generated by the application The user enters a phone number and selects a country, the `client_secret` is generated by the application
```shell script ```shell script
curl -X POST --data $'{"client_secret":"d3e285f6-972a-496c-9a22-7915a2db57c7","send_attempt":1,"country":"FR","phone_number":"+33611223344"}' 'https://matrix.org/_matrix/client/r0/register/msisdn/requestToken' curl -X POST --data $'{"client_secret":"d3e285f6-972a-496c-9a22-7915a2db57c7","send_attempt":1,"country":"FR","phone_number":"+33611223344"}' 'https://matrix.org/_matrix/client/r0/register/msisdn/requestToken'
@ -448,7 +448,7 @@ If it is not the case, the homeserver send the SMS and returns some data, especi
} }
``` ```
When you execute the register request, with the received `sid`, you get an error since the MSISDN is not validated yet: When we execute the register request, with the received `sid`, we get an error since the MSISDN is not validated yet:
```shell script ```shell script
curl -X POST --data $'{"auth":{"type":"m.login.msisdn","session":"xptUYoREDACTEDogOWAGVnbJQ","threepid_creds":{"client_secret":"d3e285f6-972a-496c-9a22-7915a2db57c7","sid":"1678881798"}}}' 'https://matrix.org/_matrix/client/r0/register' curl -X POST --data $'{"auth":{"type":"m.login.msisdn","session":"xptUYoREDACTEDogOWAGVnbJQ","threepid_creds":{"client_secret":"d3e285f6-972a-496c-9a22-7915a2db57c7","sid":"1678881798"}}}' 'https://matrix.org/_matrix/client/r0/register'
@ -558,7 +558,7 @@ curl -X POST --data $'{"auth":{"type":"m.login.msisdn","session":"xptUYoREDACTED
} }
``` ```
Now the homeserver consider that the `m.login.msisdn` step is completed (401): Now the homeserver considers that the `m.login.msisdn` step is completed (401):
```json ```json
{ {