mirror of
https://github.com/element-hq/synapse
synced 2024-09-12 03:35:10 +00:00
8fe912d95c
perl -pi -e 's#/matrix#/_matrix#g' ./cmdclient/console.py ./docs/client-server/howto.rst ./docs/client-server/specification.rst ./docs/client-server/swagger_matrix/directory ./docs/client-server/swagger_matrix/events ./docs/client-server/swagger_matrix/login ./docs/client-server/swagger_matrix/presence ./docs/client-server/swagger_matrix/profile ./docs/client-server/swagger_matrix/registration ./docs/client-server/swagger_matrix/rooms ./docs/server-server/specification.rst ./graph/graph.py ./jsfiddles/create_room_send_msg/demo.js ./jsfiddles/event_stream/demo.js ./jsfiddles/example_app/demo.js ./jsfiddles/register_login/demo.js ./jsfiddles/room_memberships/demo.js ./synapse/api/urls.py ./tests/federation/test_federation.py ./tests/handlers/test_presence.py ./tests/handlers/test_typing.py ./tests/rest/test_events.py ./tests/rest/test_presence.py ./tests/rest/test_profile.py ./tests/rest/test_rooms.py ./webclient/components/fileUpload/file-upload-service.js ./webclient/components/matrix/matrix-service.js
102 lines
2.8 KiB
Bash
102 lines
2.8 KiB
Bash
{
|
|
"apiVersion": "1.0.0",
|
|
"apis": [
|
|
{
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"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"
|
|
},
|
|
{
|
|
"method": "POST",
|
|
"nickname": "submit_login",
|
|
"notes": "If this is part of a multi-stage login, there MUST be a 'session' key.",
|
|
"parameters": [
|
|
{
|
|
"description": "A login submission",
|
|
"name": "body",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"type": "LoginSubmission"
|
|
}
|
|
],
|
|
"responseMessages": [
|
|
{
|
|
"code": 400,
|
|
"message": "Bad login type"
|
|
},
|
|
{
|
|
"code": 400,
|
|
"message": "Missing JSON keys"
|
|
}
|
|
],
|
|
"summary": "Submit a login action.",
|
|
"type": "LoginResult"
|
|
}
|
|
],
|
|
"path": "/login"
|
|
}
|
|
],
|
|
"basePath": "http://localhost:8080/_matrix/client/api/v1",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"models": {
|
|
"LoginInfo": {
|
|
"id": "LoginInfo",
|
|
"properties": {
|
|
"stages": {
|
|
"description": "Multi-stage login only: An array of all the login types required to login.",
|
|
"format": "string",
|
|
"type": "array"
|
|
},
|
|
"type": {
|
|
"description": "The login type that must be used when logging in.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"LoginResult": {
|
|
"id": "LoginResult",
|
|
"properties": {
|
|
"access_token": {
|
|
"description": "The access token for this user's login if this is the final stage of the login process.",
|
|
"type": "string"
|
|
},
|
|
"next": {
|
|
"description": "Multi-stage login only: The next login type to submit.",
|
|
"type": "string"
|
|
},
|
|
"session": {
|
|
"description": "Multi-stage login only: The session token to send when submitting the next login type.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"LoginSubmission": {
|
|
"id": "LoginSubmission",
|
|
"properties": {
|
|
"type": {
|
|
"description": "The type of login being submitted.",
|
|
"type": "string"
|
|
},
|
|
"session": {
|
|
"description": "Multi-stage login only: The session token from an earlier login stage.",
|
|
"type": "string"
|
|
},
|
|
"_login_type_defined_keys_": {
|
|
"description": "Keys as defined by the specified login type, e.g. \"user\", \"password\""
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"resourcePath": "/login",
|
|
"swaggerVersion": "1.2"
|
|
}
|
|
|