0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-14 18:43:53 +01:00

Make API docs not lie on registration/login.

This commit is contained in:
Kegan Dougal 2014-09-03 10:58:53 +01:00
parent ce5c88006e
commit 3a3fadcece
2 changed files with 24 additions and 2 deletions

View file

@ -8,7 +8,7 @@
"nickname": "get_login_info",
"notes": "All login stages MUST be mentioned if there is >1 login type.",
"summary": "Get the login mechanism to use when logging in.",
"type": "LoginInfo"
"type": "LoginFlows"
},
{
"method": "POST",
@ -45,12 +45,26 @@
"application/json"
],
"models": {
"LoginFlows": {
"id": "LoginFlows",
"properties": {
"flows": {
"description": "A list of valid login flows.",
"type": "array",
"items": {
"$ref": "LoginInfo"
}
}
}
},
"LoginInfo": {
"id": "LoginInfo",
"properties": {
"stages": {
"description": "Multi-stage login only: An array of all the login types required to login.",
"format": "string",
"items": {
"$ref": "string"
},
"type": "array"
},
"type": {
@ -66,6 +80,10 @@
"description": "The access token for this user's login if this is the final stage of the login process.",
"type": "string"
},
"user_id": {
"description": "The user's fully-qualified user ID.",
"type": "string"
},
"next": {
"description": "Multi-stage login only: The next login type to submit.",
"type": "string"

View file

@ -52,6 +52,10 @@
"user_id": {
"description": "The fully-qualified user ID.",
"type": "string"
},
"home_server": {
"description": "The name of the home server.",
"type": "string"
}
}
},