Andrew Morgan
92c6f4c38e
Add M_USER_DEACTIVATED to list of error codes ( #2234 )
...
Spec PR for [MSC 2181](https://github.com/matrix-org/matrix-doc/pull/2181 ).
Adds the `M_USER_DEACTIVATED` error code and a short description to the client-server API.
2019-08-15 18:10:38 +01:00
Richard van der Hoff
6e8739c989
Fix typo
...
Co-Authored-By: turt2live <travpc@gmail.com>
2019-01-11 08:15:08 -07:00
Travis Ralston
0eabf108d9
Add a mechanism for redirecting clients after login
...
Implements https://github.com/matrix-org/matrix-doc/pull/1730
2019-01-09 15:05:27 -07:00
Hubert Chathi
292d334509
document new login identifier object ( #1390 )
2018-08-10 16:19:17 -04:00
Travis Ralston
caa6d4d9ad
Give all errors a schema reference
...
This just helps keep an overall structure
2018-07-04 13:54:52 -06:00
Travis Ralston
7cd22f5690
Describe the rate limit error everywhere
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
2018-07-04 13:45:34 -06:00
Travis Ralston
2409c84968
Document the GET version of /login
...
Fixes https://github.com/matrix-org/matrix-doc/issues/677
2018-07-03 13:41:49 -06:00
Andrew Morgan
cd26c170de
Specify token used in /login is not an Access Token ( #1155 )
...
* Specify token used in /login is not an Access Token
While working through the implementation of /login in Dendrite, it was
confusing what the contents of the token attribute in the login request
body referred to. Initially, I thought it was an access token, which led
to further confusion. This commit explicitly states that the token is a
login token, which is separate from an access token, hopefully reducing
confusion for future readers.
Signed-off-by: Andrew Morgan (https://amorgan.xyz ) <andrew@amorgan.xyz>
2018-03-23 10:00:49 +00:00
Richard van der Hoff
00b28495a6
Explain how to split an mxid
2017-12-18 14:48:56 +00:00
Richard van der Hoff
d9a4ddbf65
Mark `home_server` field deprecated
...
This is spelt wrong, and is redundant to user_id, so let's stop people using
it.
2017-12-18 13:34:26 +00:00
Kitsune Ral
24afe7987c
Add operationId to all endpoints of all APIs
...
To facilitate generation of API stubs from the spec.
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
2017-10-11 01:58:31 +09:00
Richard van der Hoff
820704a16a
Format examples as raw objects
...
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).
The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
2017-09-27 08:04:24 +01:00
Richard van der Hoff
9265b03008
Client device doc
...
Document client devices, and the mods to the login and register apis to support
them.
2016-10-12 17:26:01 +01:00
Richard van der Hoff
f4c7fdfd03
Remove references to refresh tokens and tokenrefresh
...
refresh tokens are dead.
2016-10-03 17:05:56 +01:00
Richard van der Hoff
4b0e546eeb
PR feedback
...
Fix some typos, and clarify several aspects of server behaviour.
2016-08-09 12:02:38 +01:00
Richard van der Hoff
41368dc5a7
document CAS login
...
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
2016-08-08 17:33:48 +01:00
Richard van der Hoff
ec20f15407
/tokenrefresh should expire the access token
...
It's possible for clients to call /tokenrefresh before the access_token has
expired, potentially leading to a proliferation of valid access_tokens.
2016-07-19 09:17:14 +01:00
Richard van der Hoff
49cd65dd58
Add a license to the spec
...
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
2016-07-12 17:28:30 +01:00
Richard van der Hoff
959f1ff09f
Update the /login API spec
...
Note that /login can be used with 3pid creds
2016-05-06 16:58:04 +01:00
Richard van der Hoff
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
2016-05-03 13:57:16 +01:00
Matthew Hodgson
691d9ba664
typo :(
2016-01-05 02:47:55 +00:00
Daniel Wagner-Hall
1f5b6271f2
Generate swagger-ui output for client-server API
...
Depends on:
https://github.com/matrix-org/matrix-doc/pull/212
https://github.com/matrix-org/matrix-doc/pull/208
https://github.com/matrix-org/matrix-doc/pull/207
for the actual rendered output to not throw javascript errors at runtime.
2015-12-07 12:45:13 +00:00
Daniel Wagner-Hall
873b0dcecf
Replace version numbers with release numbers
2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall
2f3a00fe34
Consistently spell homeserver as homeserver
2015-12-02 19:23:33 +00:00
Daniel Wagner-Hall
6c66bfc755
Flatten out v1 and v2_alpha directories
...
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
2015-11-30 11:22:57 +00:00