885 Commits (dafea96621d6383f6b44d9368024bb95c8ab94a7)

Author	SHA1	Message	Date
Travis Ralston	5027a9a59a	Improve documentation around EDUs and PDUs ... Clarify fields, improve examples, and make the tables in the spec be generated rather than duplicated.	6 years ago
Travis Ralston	7679b4f1d1	Improve documentation on how Transactions work ... The response is based upon various sections of the Synapse code in how it generates a response. There are no new fields added to the transaction. Originally, `previous_ids` and `pdu_failures` were to be documented however neither of these are used in the real world.	6 years ago
David Baker	2dc51d416d	Ignore stuff in `m.` you don't understand	6 years ago
David Baker	f90ed4b77d	Make non-namespaced tags verboten	6 years ago
David Baker	e4fd088fcc	Fix room tags spec	6 years ago
Travis Ralston	8f1a4ae0ea	Formatting	6 years ago
Travis Ralston	9fdd8a6f96	Document how leaving rooms/rejecting invites over federation works ... Fixes https://github.com/matrix-org/matrix-doc/issues/1401 This is very similar to the joining rooms handshake, and much of it is a near copy/paste of the make_join and send_join API. The major difference is the send_leave API doesn't return anything. References: * Handling of make_leave: d69decd5c7/synapse/handlers/federation.py (L1285-L1310) * send_leave route: d69decd5c7/synapse/federation/transport/client.py (L267) * make_leave route: d69decd5c7/synapse/federation/transport/server.py (L396) * send_leave returning nothing: d69decd5c7/synapse/handlers/federation.py (L1346)	6 years ago
Travis Ralston	f873bae0cc	Improve documentation for how non-third party invites work ... The details are fairly straightforward. An `event` has been added to the response body because that's what Synapse returns, despite the spec saying otherwise until now: d69decd5c7/synapse/federation/federation_server.py (L339)	6 years ago
Travis Ralston	c2f1c6e78d	Improve the joining rooms handshake documentation ... There isn't a whole lot to this section that needed work. The section overall lost the table schema in favour of having the endpoints close by. The directory query is improved in https://github.com/matrix-org/matrix-doc/pull/1443	6 years ago
Travis Ralston	8e97b0ca81	Improve the server key exchange portion of the s2s specification ... Most of the text has been shuffled into the swagger definitions to bring it closer to where it matters. This also attempts to clarify what is out in the wild. Most importantly, the first version of the key exchange is outright removed from the specification. Other research points/questions are: * What is a "Key ID"? * 1241156c82/synapse/rest/key/v2/local_key_resource.py (L81-L83) * 1241156c82/synapse/rest/key/v2/local_key_resource.py (L88-L91) * Returning a cached response if the server throws a 400, 500, or otherwise not-offline status code * 1241156c82/synapse/rest/key/v2/remote_key_resource.py (L227-L229) * `minimum_valid_until_ts` default * This branch of the ladder: 1241156c82/synapse/rest/key/v2/remote_key_resource.py (L192) * Returning empty arrays when querying offline/no servers * Queried by hand against matrix.org as a notary server with a fake domain name to query * Returning all keys even when querying for specific keys * Queried by hand using matrix.org as a notary server against a server publishing multiple keys. The examples and descriptions were also improved as part of this commit.	6 years ago
Travis Ralston	0ddf578b61	Combine all queries into their own section ... This removes the Directory and Profile sections, instead opting to document them as Queries. The behaviour of profile queries is based on Synapse's behaviour. A few issues have been opened to improve the behaviour: * https://github.com/matrix-org/matrix-doc/issues/1434 * https://github.com/matrix-org/matrix-doc/issues/1435 * https://github.com/matrix-org/matrix-doc/issues/1436 * https://github.com/matrix-org/matrix-doc/issues/1437 This fixes https://github.com/matrix-org/matrix-doc/issues/1404	6 years ago
Will Hunt	bdb881420c	Merge branch 'master' into hs/dns-to-be-hostname	6 years ago
Travis Ralston	004998b98f	Convert invites to swagger ... The whole section reads like a description for the endpoint, and has been replaced by the swagger definition now (rather than at a later stage). All the same information should be kept.	6 years ago
Travis Ralston	f09c4fd286	Convert joins to swagger	6 years ago
Travis Ralston	24e531a896	Merge pull request #1406 from turt2live/travis/s2s/transactions-swagger ... Convert things that mention "Transaction" to swagger	6 years ago
Michael Telatynski	2790c1f069	Merge pull request #1289 from matrix-org/t3chguy/group_id ... basic spec for group IDs, mostly copied from User IDs as they share grammar	6 years ago
Travis Ralston	cb4fcd1d09	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger	6 years ago
Will Hunt	26505533dd	drop dns_name = host in favour of host	6 years ago
Ben Parsons	01d01cfbbb	Merge pull request #1440 from matrix-org/benp/clarifyintro ... Improve discoverability of /docs/spec/intro/ document by including content in /docs/spec/	6 years ago
Ben Parsons	07aeaadef9	update links which used to point to docs/spec/intro	6 years ago
Travis Ralston	2aafde4549	Merge pull request #1419 from turt2live/travis/s2s/3pinvites-swagger ... Convert third party invite exchange to swagger	6 years ago
Ben Parsons	e7c79f2bd4	avoid .rst link conflict warnings	6 years ago
Ben Parsons	54d6d58fff	naively move content from intro.rst to index.rst	6 years ago
Travis Ralston	e226b60c7f	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger	6 years ago
Travis Ralston	7cb918407d	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/keys-swagger	6 years ago
Travis Ralston	cf93c88337	Convert third party invite exchange to swagger	6 years ago
Travis Ralston	51faf8ed2e	Convert the general query API to swagger ... Includes "moving" the directory query API into the same area. This will make more sense once the other query types are specified.	6 years ago
Travis Ralston	91c59e7384	Merge pull request #1353 from matrix-org/anoa/as_thirdparty_lookup ... Thirdparty Entity Lookup API	6 years ago
Andrew Morgan	291a4dfc76	Third party lookup module. Fix wording	6 years ago
Andrew Morgan	114bcf1a2e	Use $ref, clean up, fix errors, AS is now a C-S module.	6 years ago
Travis Ralston	374ec00046	Convert things that mention "Transaction" to swagger ... There's two kinds of transactions currently: one with EDUs and one without. The one with EDUs is only used on /send, however the schema is still somewhat worth splitting out for simplicity. The examples are brought apart to make them slightly more reusable for when they get dumped into the relevant sections of the spec (see TODO in server_server_api.rst) Further, the Transactions stuff introduces tuples to the spec. The units.py has been updated to support this.	6 years ago
Travis Ralston	96889f16e9	Split out and fix the /server and /query key APIs	6 years ago
Travis Ralston	bd2c0b7c98	Convert server keys to swagger	6 years ago
Travis Ralston	423d5593f5	Generify how OPTIONS and CORS are handled	6 years ago
Travis Ralston	dd9414472b	Merge remote-tracking branch 'matrix-org/master' into travis/cors	6 years ago
Andrew Morgan	8e22e9e85a	Fix title underline length	6 years ago
Andrew Morgan	cc3724b54a	fix indentation, error messages. add rest of PR	6 years ago
Will Hunt	92f3989f2b	Dirty replace of DNS name -> hostname	6 years ago
Travis Ralston	0779d81e52	Clarify which requests should have CORS headers ... Spoilers: all of them.	6 years ago
Travis Ralston	2fc2926461	Clearly say that the server/server API is unstable and subject to change	6 years ago
Travis Ralston	4ca54404fa	Document the CORS/preflight headers ... Fixes https://github.com/matrix-org/matrix-doc/issues/1006	6 years ago
Andrew Morgan	d73b247688	3PE lookup service	6 years ago
Travis Ralston	d647169806	Add more strength to the suggestion to find existing issues ... Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	fc402c296b	Don't suggest reusing old issues for spec proposals ... In practice this was confusing for people, so instead we should encourage people to create new issues and reference the existing ones. Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
user	54c3003b74	newly joined -> newly-joined	6 years ago
user	5ab5fe08d1	Small grammatical and stylistic fixes	6 years ago
Andrew Morgan	2e5cdaf51c	Fix typo ... "To stream events all the events" -> "To stream all the events"	6 years ago
Michael Telatynski	c3f66e1814	basic spec for group IDs, mostly copied from User IDs as they share grammar	6 years ago
Michael Kaye	72282577bf	Add back proposals.rst with a link to the actual location	6 years ago
Ben Parsons	18ba0d6d81	remove propsals.rst as it will be regenerated	6 years ago
Ben Parsons	a552c1853e	update for MSC 701	6 years ago
Richard van der Hoff	cefd1a832e	server_server_api: fix typo in auth section ... fixes "destintation" typo	6 years ago
Ben Parsons	ffb8037af2	update MSC list	6 years ago
Ben Parsons	ee98082a60	update MSC1270	6 years ago
Travis Ralston	8610effad7	Merge branch 'master' into travis/reporting	6 years ago
Ben Parsons	7a44351a34	update following rvdh spec blitz	6 years ago
Ben Parsons	34090b24c4	prepare proposals.py for CI	6 years ago
Travis Ralston	9037f506ac	Document how to report content ... Fixes: https://github.com/matrix-org/matrix-doc/issues/739 Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Ben Parsons	c3062b7db6	Include Proposals Page Title, update MSC1256	6 years ago
Ben Parsons	434e2949f9	include #1256	6 years ago
Ben Parsons	8d550d2166	force re-render	6 years ago
Ben Parsons	0b776b0e9c	link to proposals page from index	6 years ago
Jason Volk	2a6895e759	Fix typo.	6 years ago
Ben Parsons	663e1a5ebe	Update some text	6 years ago
Ben Parsons	9873a2a0ac	link from the spec intro page	6 years ago
Ben Parsons	38adc7df06	latest generated proposals	6 years ago
Matthew Hodgson	8440179ecf	clarify shepherds and clarify 'greater benefit' ... as per https://github.com/matrix-org/matrix-doc/pull/1240#discussion_r188459957	6 years ago
Ben Parsons	4d3c4225b2	include proposal template link	6 years ago
Matthew Hodgson	84524df783	spell out requirements for doc editing	6 years ago
Ben Parsons	73b28612ec	updates from feedback on pull	6 years ago
Matthew Hodgson	4c0743ef65	fix wording	6 years ago
Matthew Hodgson	10a8cb3f67	put handwavey timings on state transitions	6 years ago
Matthew Hodgson	4cdb4f105c	clarify architecture	6 years ago
Matthew Hodgson	8096bf0039	perms and apostrophes	6 years ago
Matthew Hodgson	3e10a5a24a	enter #matrix-spec:matrix.org	6 years ago
Matthew Hodgson	42fd3f34e4	shift stuff from contributing.rst to the new proposals page	6 years ago
Matthew Hodgson	3b736388ce	clarify governance	6 years ago
Ben Parsons	3cef79f31d	sublist formatting	6 years ago
Matthew Hodgson	e27f674fb9	incept dates	6 years ago
Matthew Hodgson	29348c6190	improve wording	6 years ago
Matthew Hodgson	714767c95a	explain proposal neutrality	6 years ago
Matthew Hodgson	755c9473fb	more tweaks	6 years ago
Matthew Hodgson	07bf61b33b	more tweaks	6 years ago
Matthew Hodgson	93681458d6	more tweaks	6 years ago
Matthew Hodgson	cb882ba12d	more tweaks	6 years ago
Matthew Hodgson	8c469e51cb	lots of tweaks to the MSC verbiage	6 years ago
Ben Parsons	b8f38b21a7	update introductory text	6 years ago
Ben Parsons	120fa92078	update intro	6 years ago
Ben Parsons	867307af8b	new flow	6 years ago
Ben Parsons	866b0b6348	I mostly play with ascii art	6 years ago
Ben Parsons	9e37d15c8f	little ascii diagram of process	6 years ago
Ben Parsons	e18aa30fd2	start generating new proposals page	6 years ago
Jason Volk	2802fdea7e	Fix typo.	6 years ago
Richard Lewis	8d05f80cec	Sticker messages (m.sticker) (#1158)	6 years ago
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>	6 years ago
Vyom Sharma	4f5ad35865	fixed minor typo	6 years ago
Travis Ralston	331e49bd0d	Improve the documentation of ignored users ... * Fix the event schema to represent the real world * Add the module to the spec targets * Remove incomplete thought from the client behaviour * Link to the account data API * Minor word choice changes Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	d37ed0876f	Merge branch 'master' into travis/m.ignored_user_list	6 years ago
Richard van der Hoff	a0dda3cae2	Merge branch 'master' into travis/m.tag	6 years ago
Travis Ralston	e862ef60ae	Spec ignoring users ... Adds https://github.com/matrix-org/matrix-doc/issues/528 Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	a3f006353c	Tag ordering is defined as a number between 0 and 1, not strings ... Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Maxime Dor	c8393306d1	Add IS ping endpoint	6 years ago
Richard van der Hoff	3dfa643b8b	Fix membership state names ... It's called 'join', not 'joined'.	6 years ago
Michael Telatynski	4d90d2b495	fix depr link	6 years ago
Nathan Musoke	7e94cd5a0b	Typo in client-server spec: ether -> either	7 years ago
Richard van der Hoff	73118b6b29	Merge pull request #1096 from t3chguy/user_directory ... add user_directory	7 years ago
Michael Telatynski	784adade9b	changes based on Pull Request feedback	7 years ago
Richard van der Hoff	15ca952cc3	remove spurious word	7 years ago
Richard van der Hoff	1fb7647021	send_join: clarify auth_chain description ... The auth_chain field should contain all of the auth events required to auth the state events, as well as those required to auth the join event itself. (cf https://github.com/matrix-org/synapse/blob/e148438/synapse/handlers/federation.py#L1076-L1077).	7 years ago
Michael Telatynski	3d8fe6e090	merge profiles with user directory into user data, also fix typo	7 years ago
Michael Telatynski	605510e965	Merge branch 'master' into user_directory	7 years ago
Richard van der Hoff	a36f8ba00d	Forbid colons in MXIDs ... There is a single (AS) user on matrix.org who has a colon in their localpart, but I suspect that is an artifact of old bridge code and won't work over federation anyway. Colons in MXIDs are particularly harmful because they make it impossible to split mxids into local- and remote-parts	7 years ago
Michael Telatynski	97445195f6	add user_directory	7 years ago
Richard van der Hoff	08d137a588	We sign the request body, not the JSON ... when signing federation requests, we put the actual request body into the canonicaljson to be signed, not the JSON representation of it.	7 years ago
Richard van der Hoff	56f878842c	Add a warning that state resolution has problems	7 years ago
Richard van der Hoff	5ab9ee6b88	Link to auth rules	7 years ago
Richard van der Hoff	0960229a80	Document the state resolution algorithm ... or at least, my understanding of it.	7 years ago
Maxime Dor	e8af5622a7	Use proper room event type for redaction	7 years ago
Richard van der Hoff	ec1a12d21b	Merge pull request #1080 from maxidor/max/ss/auth_rules ... Fix auth rules to allow first PL event	7 years ago
Richard van der Hoff	96d93e11d7	Tweak wording of auth rules slightly	7 years ago
Florian Jacob	a0455eb5b1	Threat Model: Wrong word: Banning users is a threat only if you're not authorized ... Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>	7 years ago
Florian Jacob	306b3f5d62	Threat Model: Align indentation of Spying Threats. ... “Disclosure to Servers Within Chatroom” was indented lesser than the surrounding threats. Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>	7 years ago
Maxime Dor	c4f53f58d7	Fix auth rules to allow first PL event	7 years ago
Richard van der Hoff	52dba5d89a	Merge pull request #1076 from florianjacob/fix-cas-url ... Correct CAS spec link	7 years ago
Richard van der Hoff	58a3fa3d60	Merge pull request #1075 from matrix-org/rav/pdu_fields ... Improve documentation of Transactions and PDUs	7 years ago
Florian Jacob	ac861d9b97	Correct CAS spec link ... Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>	7 years ago
Richard van der Hoff	6a653b742c	Document auth_events	7 years ago
Richard van der Hoff	632ba032af	Improve Transaction and PDU documentation ... Fix a bunch of lies about the fields in these structures.	7 years ago
Marcus Medom Ryding	8a446fa6df	Modify event auth rules not to rely on depth ... Signed-off-by: Marcus Medom Ryding <mrok4a@gmail.com>	7 years ago
Richard van der Hoff	f88185ed89	Merge pull request #1073 from maxidor/max/ss/directory ... Document directory query endpoint	7 years ago
Richard van der Hoff	e9c1b87a1d	Remove `git log` reference ... We keep the changelog up to date anyway, so there's not much point in trying to get people to use `git log`	7 years ago
Richard van der Hoff	0ce58fdb28	Prepare for next spec dev cycle	7 years ago
Maxime Dor	bb50ec2e88	Document directory query endpoint	7 years ago
Richard van der Hoff	9b0bdb799e	Merge pull request #1054 from vberger/patch-2 ... Specify namespaces for tags	7 years ago
Maxime Dor	1045bc721d	Document federation version endpoint	7 years ago
David Baker	14df31458b	Attempt to clarify example a little	7 years ago
David Baker	9c5972ffe3	More formatting / grammar	7 years ago
David Baker	e12c0b54ff	Formatting & grammar	7 years ago
David Baker	4526ff2ea6	Double backticks in rst :/	7 years ago
David Baker	1e4cba6b55	Don't linkify email addresses in examples	7 years ago
David Baker	3487f5d75a	Spell out what we mean by a 3pid ... (and consequently rejig all the fixed-width formatting)	7 years ago
David Baker	ff85ec055e	Move 3pid types down	7 years ago
David Baker	8d557ec9dc	Actually this isn't necessary in this section	7 years ago
David Baker	e80675c9e9	Link in markdown, not swagger	7 years ago
David Baker	b789f61522	Make link more specific	7 years ago
David Baker	6edb90a08e	Document threepids ... Adds the /msisdn' 3pid type and generally fleshes out what a 3pid is and how they work. This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039 with some tweaks and additions.	7 years ago
Travis Ralston	b1801ea6db	Spec /account/whoami ... Signed-off-by: Travis Ralston <travpc@gmail.com>	7 years ago
Maxime Dor	68e12feec7	Add explicit examples for JSON encoding	7 years ago
Victor Berger	cc8128edad	Specify namespaces for tags ... This is a proposition for closing #931. This should be a fairly uncontroversial addition (apart from bike-shedding), which only defines behavior for clients that want use tags or expose tagging functionality to their users. The idea of adding this to the spec is to ensure clients can peacefully share the tag namespace without conflicting with each other, using rules similar to namespaces for state keys.	7 years ago
Michael Telatynski	c2b1b7a10e	mention that we can send tokens via headers	7 years ago