Some update

This commit is contained in:
ChronosX88 2019-12-29 18:40:17 +04:00
parent 7474e63fd3
commit f55dbf9967
Signed by: ChronosXYZ
GPG Key ID: 085A69A82C8C511A
2 changed files with 12 additions and 5 deletions

View File

@ -15,7 +15,7 @@ This extension is intended for logging into user account on a server by username
## Use cases ## Use cases
*Request*: - Request:
```json ```json
{ {
@ -29,7 +29,7 @@ This extension is intended for logging into user account on a server by username
} }
``` ```
*Response*: - Response:
```json ```json
{ {
@ -44,7 +44,7 @@ This extension is intended for logging into user account on a server by username
} }
``` ```
*<b>Error</b> response*: - Error response:
```json ```json
{ {
@ -72,10 +72,14 @@ None.
```typescript ```typescript
interface LoginRequestPayload { interface LoginRequestPayload {
/** /**
* The username of account which user wants to login * The username of account which user wants to login (can be omit if we set thirdPID)
*/ */
username: string, username: string,
/**
* Third party ID which have user (can be omit if we set username)
*/
thirdPID: string,
/** /**
* Password of new account * Password of new account

View File

@ -18,6 +18,8 @@ This extension is intended for creating user accounts on a server
### Basic registration flow ### Basic registration flow
`// TODO: introduce email/msisdn confirmation which prevents spam attacks`
- Client: - Client:
```json ```json
@ -31,7 +33,8 @@ This extension is intended for creating user accounts on a server
{"type":"email", "value":"juliet@capulett.com"}, {"type":"email", "value":"juliet@capulett.com"},
{"type":"msisdn", "value":"+1234567890"}, {"type":"msisdn", "value":"+1234567890"},
], ],
"password": "romeo1" "password": "romeo1",
"loginOnSuccess": false
} }
} }
``` ```