forked from MirrorHub/synapse
Make API docs not lie on registration/login.
This commit is contained in:
parent
ce5c88006e
commit
3a3fadcece
2 changed files with 24 additions and 2 deletions
|
@ -8,7 +8,7 @@
|
||||||
"nickname": "get_login_info",
|
"nickname": "get_login_info",
|
||||||
"notes": "All login stages MUST be mentioned if there is >1 login type.",
|
"notes": "All login stages MUST be mentioned if there is >1 login type.",
|
||||||
"summary": "Get the login mechanism to use when logging in.",
|
"summary": "Get the login mechanism to use when logging in.",
|
||||||
"type": "LoginInfo"
|
"type": "LoginFlows"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"method": "POST",
|
"method": "POST",
|
||||||
|
@ -45,12 +45,26 @@
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
"models": {
|
"models": {
|
||||||
|
"LoginFlows": {
|
||||||
|
"id": "LoginFlows",
|
||||||
|
"properties": {
|
||||||
|
"flows": {
|
||||||
|
"description": "A list of valid login flows.",
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "LoginInfo"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"LoginInfo": {
|
"LoginInfo": {
|
||||||
"id": "LoginInfo",
|
"id": "LoginInfo",
|
||||||
"properties": {
|
"properties": {
|
||||||
"stages": {
|
"stages": {
|
||||||
"description": "Multi-stage login only: An array of all the login types required to login.",
|
"description": "Multi-stage login only: An array of all the login types required to login.",
|
||||||
"format": "string",
|
"items": {
|
||||||
|
"$ref": "string"
|
||||||
|
},
|
||||||
"type": "array"
|
"type": "array"
|
||||||
},
|
},
|
||||||
"type": {
|
"type": {
|
||||||
|
@ -66,6 +80,10 @@
|
||||||
"description": "The access token for this user's login if this is the final stage of the login process.",
|
"description": "The access token for this user's login if this is the final stage of the login process.",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
|
"user_id": {
|
||||||
|
"description": "The user's fully-qualified user ID.",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
"next": {
|
"next": {
|
||||||
"description": "Multi-stage login only: The next login type to submit.",
|
"description": "Multi-stage login only: The next login type to submit.",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
|
|
|
@ -52,6 +52,10 @@
|
||||||
"user_id": {
|
"user_id": {
|
||||||
"description": "The fully-qualified user ID.",
|
"description": "The fully-qualified user ID.",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
|
},
|
||||||
|
"home_server": {
|
||||||
|
"description": "The name of the home server.",
|
||||||
|
"type": "string"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
Loading…
Reference in a new issue