matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
Travis Ralston	caa6d4d9ad	Give all errors a schema reference This just helps keep an overall structure	6 years ago
Travis Ralston	7cd22f5690	Describe the rate limit error everywhere Fixes https://github.com/matrix-org/matrix-doc/issues/1153	6 years ago
Richard van der Hoff	a549baa01d	registration.yaml: fix typo it's -> its	7 years ago
Travis Ralston	15cdde3f49	Add GET /register/available Adds https://github.com/matrix-org/matrix-doc/issues/911 Signed-off-by: Travis Ralston <travpc@gmail.com>	7 years ago
Richard van der Hoff	00b28495a6	Explain how to split an mxid	7 years ago
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.	7 years ago
Gergely Polonkai	e9622bf9e4	Fix example in email based registration endpoint The spec says `send_attempt` should be a number, but the example shows it as a string. Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>	7 years ago
Kitsune Ral	66268260c7	Merge remote-tracking branch 'remotes/origin/master'	7 years ago
Richard van der Hoff	628e723483	Move the MXID spec to the appendices Also link to them from the /register API doc.	7 years ago
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>	7 years ago
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.	7 years ago
Richard van der Hoff	c83a556097	Set default account 'kind' to 'user' Fixes https://github.com/matrix-org/matrix-doc/issues/736	8 years ago
Richard van der Hoff	9265b03008	Client device doc Document client devices, and the mods to the login and register apis to support them.	8 years ago
Richard van der Hoff	f4c7fdfd03	Remove references to refresh tokens and tokenrefresh refresh tokens are dead.	8 years ago
Richard van der Hoff	c51c4acf7f	Clarifications to authentication mechanisms * Make the purpose of the `auth` key in /register requests explicit, and say that it should be empty at first. * Restructure the UA-auth section a bit. * In the UA-auth section, say that clients should submit no `auth` to start with, and add 'Stage 0' representing this to the example. * s/{stage,login} type/authentication type/ in the UA-auth section. Seems clearer to me. * Try to distinguish the example responses from the example requests by giving an HTTP header.	8 years ago
Erik Johnston	a48437ced8	Spec /account/deactivate API	8 years ago
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).	8 years ago
David Baker	e91214e78e	More links Also remove now redundant anchor	8 years ago
David Baker	7c8651480a	Some PR feedback corrections Including adding a hyperlink, although this requires a separate fix that I'll do on a different branch	8 years ago
David Baker	c109da5b78	Attempt to make things clearer	8 years ago
David Baker	86db820bb1	Expand on summaries for requestToken endpoints	8 years ago
David Baker	191cb08a3a	Add response section otherwise the checker fails	8 years ago
David Baker	ead5648b8c	Add requestToken endpoints For password reset and 3pid adding	8 years ago
David Baker	14ff3862e3	More PR feedback	8 years ago
David Baker	e4db7be8e2	Better structure for error response & add server not trusted error	8 years ago
David Baker	3dddc0dcdf	Explain why not erroring on dup 3pid is desireable	8 years ago
David Baker	a600386c05	Consistent working for error response Also format json example better	8 years ago
David Baker	60293af83a	PR feedback	8 years ago
David Baker	6a0c9edb49	Add the id_server param	8 years ago
David Baker	b0194a3016	Spec for endpoint-specific 3pid verification token As per proposal https://docs.google.com/document/d/13mapDbaOnbob9ZYRDiGm1YbeZhFOBj_R1OvgBA9pA5s/edit?pref=2&pli=1#	8 years ago
Richard van der Hoff	3bce28a15c	Clarifications to the 'Client authentication' section * Use the terminology 'login type' everywhere instead of mixing up 'stage type' and 'login type' * Don't have a separate 'APIs using the User-Interactive Authentication mechanism' section, because (a) it doesn't make much sense to organise the APIs this way, and (b) it was a set of lies anyway. * Move '/account/password' definition into registration.yaml so that register and password can share a section in the spec; remove duplicate doc for /password. * Write some words on using 3pids for /login	9 years ago
Richard van der Hoff	9efd021f5e	Document the user-interactive api params Document the parameters and responses on /register and /account/password which are invoved in the user-interactive auth	9 years ago
David Baker	169cc98101	M_INVALID_USERNAME to be consistent with the name of the parameter	9 years ago
David Baker	2301a792d7	Add an error code for invalid user names.	9 years ago
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.	9 years ago
Daniel Wagner-Hall	873b0dcecf	Replace version numbers with release numbers	9 years ago
Daniel Wagner-Hall	2f3a00fe34	Consistently spell homeserver as homeserver	9 years ago
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.	9 years ago

38 Commits (5027a9a59a4ca257f6b71f78f6f0fe3811940400)