wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #95 from matrix-org/rav/login-api-fixes

Browse source 
Clean up some untruths in the login api doc
This commit is contained in:
Kegsay 2015-10-15 09:55:31 +01:00
commit 6a70828400
1 changed files with 16 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

19
api/client-server/v1/login.yaml
View file

@ -33,17 +33,21 @@ paths:
type: object
example: |-
{
"username": "cheeky_monkey",
"type": "m.login.pasword",
"user": "cheeky_monkey",
"password": "ilovebananas"
}
properties:
username:
type:
type: string
description: The login type being used. Currently only "m.login.password" is supported.
user:
type: string
description: The fully qualified user ID or just local part of the user ID, to log in.
password:
type: string
description: The user's password.
required: ["username", "password"]
required: ["type", "user", "password"]
responses:
200:
description: The user has been authenticated.
@ -78,6 +82,15 @@ paths:
home_server:
type: string
description: The hostname of the Home Server on which the account has been registered.
400:
description: |-
Part of the request was invalid. For example, the login type may not be recognised.
examples:
application/json: |-
{
"errcode": "M_UNKNOWN",
"error": "Bad login type."
}
403:
description: |-
The login attempt failed. For example, the password may have been incorrect.