matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
Travis Ralston	4b9922b641	Merge pull request #1494 from turt2live/travis/general/openid Document OpenID in the client-server and server-server APIs	6 years ago
Travis Ralston	2aa0e7b00f	Merge pull request #1483 from turt2live/travis/s2s/typing Document how typing notifications work over federation	6 years ago
Travis Ralston	fde48e7ee8	Specify how room versioning works This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425 Room version upgrades are not part of MSC1425. Documented aspects: * room_version on the create event * creating a room with a specific version (useful for testing) * make_join behaviour * error code documentation * grammar of room versions Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit	6 years ago
Travis Ralston	a556e33eb9	Spec /3pid/onbind Fixes https://github.com/matrix-org/matrix-doc/issues/1422	6 years ago
Travis Ralston	25c77ab2d0	Define authorization requirements on federation swagger APIs	6 years ago
Travis Ralston	56dbeeb22a	Merge pull request #1469 from turt2live/travis/s2s/backfill Improve documentation for backfilling rooms	6 years ago
Travis Ralston	721be47eb1	Describe how get_missing_events actually works The original text wasn't far off, except for being wrong about what the fields actually do. This commit also adds a bit of clarity for how the server is expected to behave.	6 years ago
Travis Ralston	0a7e670715	Document how typing notifications work over federation Relevant synapse code: `d69decd5c7/synapse/handlers/typing.py (L221-L230)`	6 years ago
Travis Ralston	e03bfbc47b	Document how read receipts work over federation Federation format: `d69decd5c7/synapse/handlers/receipts.py (L153-L166)` Population of the fields that the above uses to construct the EDU: `d69decd5c7/synapse/handlers/receipts.py (L48-L56)`	6 years ago
Travis Ralston	05a2427c73	Document how presence EDUs work between servers It's worth noting that Synapse does not make use of the `poll` or `unpoll` fields, and therefore the wording has been updated to permit servers to reject users. In the case of synapse, it would automatically reject everyone in the list by nature of ignoring it.	6 years ago
Travis Ralston	a77975ba68	Merge pull request #1450 from turt2live/travis/s2s/inviting-rooms Improve documentation for how non-third party invites work	6 years ago
Travis Ralston	0f8954d839	Merge pull request #1463 from turt2live/travis/s2s/pdus-and-edus Improve documentation around EDUs and PDUs	6 years ago
Travis Ralston	57eeddd849	Remove unused origin and destination on EDUs	6 years ago
Travis Ralston	dcae88c290	Document OpenID in the server-server API Part of https://github.com/matrix-org/matrix-doc/issues/857 Reference: `d69decd5c7/synapse/federation/transport/server.py (L543-L557)`	6 years ago
Travis Ralston	cfdbee5fc2	EDU origin and destinations aren't required	6 years ago
Travis Ralston	7ada91787a	age_ts isn't real	6 years ago
Travis Ralston	521dcdd5d5	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/backfill	6 years ago
Travis Ralston	35f15ba3d8	Merge pull request #1477 from turt2live/travis/s2s/public-rooms Document the /publicRooms endpoint for federation	6 years ago
Travis Ralston	8724ed99ad	Merge pull request #1480 from turt2live/travis/s2s/swagger-consumes-json Specify which federation swagger APIs consume JSON	6 years ago
Travis Ralston	e10770ae8b	Merge pull request #1475 from turt2live/travis/s2s/event-auth Document /event_auth and /query_auth	6 years ago
Travis Ralston	ef9d766dc3	Remove irrelevant TODO We fixed the EDU, so we don't need this comment.	6 years ago
Travis Ralston	2e6d6e2790	Specify which swagger APIs consume JSON	6 years ago
Travis Ralston	8dd63388e0	invites consume JSON	6 years ago
Travis Ralston	13a2b54bf9	query_auth consumes JSON	6 years ago
Travis Ralston	6ac25d167c	get_missing_events consumes JSON	6 years ago
Travis Ralston	2ac80d38d7	Document the /publicRooms endpoint for federation This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476 The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs. The inputs (and behaviour) are based upon the docstring here: `43ecfe0b10/synapse/federation/transport/server.py (L583-L612)`	6 years ago
Travis Ralston	73958ecbff	Document /event_auth and /query_auth /event_auth is a fairly easy endpoint to determine the use case of. /query_auth is a little harder to investigate and has a fairly interesting purpose: it appears to be used for the sending server to admit defeat and shop around for the right auth chain, correcting it's own perspective as it goes. /query_auth is based off the following research points in synapse: * `43ecfe0b10/synapse/handlers/federation.py (L1947-L1990)` * `43ecfe0b10/synapse/handlers/federation.py (L2049-L2187)` * `43ecfe0b10/synapse/handlers/federation.py (L1716-L1761)` * `43ecfe0b10/synapse/federation/federation_server.py (L393-L446)` * https://github.com/matrix-org/synapse/blob/master/synapse/federation/transport/server.py#L482-L487	6 years ago
Travis Ralston	6b67d501e4	Merge branch 'master' into travis/s2s/query	6 years ago
Travis Ralston	3a9fb11c9b	Merge branch 'master' into travis/s2s/backfill	6 years ago
Travis Ralston	1578da453b	Merge branch 'master' into travis/s2s/get-event	6 years ago
Travis Ralston	86d7f42173	Merge pull request #1455 from turt2live/travis/s2s/leaving-rooms Document how leaving rooms/rejecting invites over federation works	6 years ago
Travis Ralston	d48f1e1713	Merge pull request #1461 from turt2live/travis/s2s/transactions Improve documentation on how Transactions work	6 years ago
Travis Ralston	cda88f3b3d	Document /get_missing_events Fixes https://github.com/matrix-org/matrix-doc/issues/1385	6 years ago
Travis Ralston	e766606f24	join -> leave	6 years ago
Travis Ralston	0b313dbdd9	Don't explain what a 400 Bad Request is	6 years ago
Travis Ralston	05bb7e1050	Spelling and word choice	6 years ago
Travis Ralston	53d4003d3a	manual merge of master into travis/s2s/query	6 years ago
Travis Ralston	48972addbf	Merge pull request #1428 from turt2live/travis/s2s/joining-rooms Improve the documentation for joining rooms	6 years ago
Travis Ralston	5596243add	origin is required	6 years ago
Travis Ralston	8b7bc60367	list -> array	6 years ago
Travis Ralston	9d474bb819	Document event retrieval endpoints in more detail This also adds a previously-undocumented endpoint: /state_ids Backfill is technically not part of this section, however it is being left untouched to make the merge with #1469 easier (which moves it out of the file). Reference material: * Some calls to synapse on these endpoints with a relatively simple private room.	6 years ago
Travis Ralston	4b1955f395	Clarify what the auth_events on a PDU are	6 years ago
Travis Ralston	5aef545128	Improve documentation for backfilling rooms There's not a whole lot to improve here - most of the changes are about reorganization and minor clarifications.	6 years ago
Travis Ralston	d0e8df8f3f	prev_content is an object	6 years ago
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
Travis Ralston	73b0a03b9b	Remove more padding	6 years ago
Travis Ralston	cafd1a9ab3	Use more modern timestamps	6 years ago
Travis Ralston	e27f4a69a0	Key versions must be [0-9a-zA-Z_]	6 years ago
Travis Ralston	bdccfca726	Timestamps should be in milliseconds	6 years ago
Travis Ralston	cad1db2a14	Unpadded means unpadded	6 years ago
Travis Ralston	9dbb627d7b	Undo accidental changes to the operation ID	6 years ago
Travis Ralston	2f71703427	Deprecate key ID querying	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	fcaa299f81	Include information on how invite_room_state works This is completely optional, and the events included are up to the sender. Sources: * Structure: `d69decd5c7/synapse/handlers/message.py (L896-L904)` * What events are recommended: `d69decd5c7/synapse/config/api.py (L30-L40)`	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	d914c402e2	Improve the profile query to have more sane responses This is a mix of Synapse and Dendrite behaviour, mostly Dendrite. Synapse returns `null` for field values that aren't set, however Dendrite just doesn't return them and instead opts for an empty object. Further, synapse is lacking in error codes in this area. Dendrite does some additional validation on this API which introduces more errors for bad requests, instead of defaulting to empty objects/200 OK responses. Likewise, Dendrite returns a 404 when the user is not found while Synapse returns 200 OK/empty object.	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
Travis Ralston	b0744aa1e9	Merge pull request #1413 from turt2live/travis/s2s/join-swagger Convert joins/invites to swagger	6 years ago
Travis Ralston	af0629a520	Full stop	6 years ago
Travis Ralston	9f399a08fe	Full stops I'm never going to remember these	6 years ago
Travis Ralston	0d1b82a601	Add the event_id to unsigned PDUs This went missing in the swagger conversion. The example already has an event_id.	6 years ago
Travis Ralston	eaf175056f	Full stops	6 years ago
Travis Ralston	7314405904	Update comment	6 years ago
Travis Ralston	45ec8269e6	Fill out the required fields in all the examples	6 years ago
Travis Ralston	9c1c541a38	Remove extra "required" declarations "required" is something that is handled as an array, and these are invalid. The `type` in both cases is covered by a required array elsewhere	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	cb4fcd1d09	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger	6 years ago
Travis Ralston	88beaf4ad8	Completely remove /pull It's not been in use for years - we can safely let it disappear	6 years ago
Travis Ralston	21c4af70a9	Fix schema definitions (spelling, attributes)	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
Travis Ralston	89384c96c1	Full stops, language.	6 years ago
Travis Ralston	e226b60c7f	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger	6 years ago
Travis Ralston	bafdcf3640	Full stops, spelling, and operation IDs.	6 years ago
Travis Ralston	7cb918407d	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/keys-swagger	6 years ago
Travis Ralston	272f3d8432	Fix documentation link	6 years ago
Travis Ralston	cf93c88337	Convert third party invite exchange to swagger	6 years ago
Travis Ralston	e5da1e1741	Improve upon the transaction schema and examples Reduces data duplication and makes the objects more reusable for other areas of the spec	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	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	3e13ec2841	Fix required properties in POST /query	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
user	5ab5fe08d1	Small grammatical and stylistic fixes	7 years ago
Maxime Dor	9d2e18cca1	Adapt paths as per feedback	7 years ago
Maxime Dor	d1e64daa10	Fix yaml title for directory api	7 years ago
Maxime Dor	28c09aed62	Properly mark required response keys to pass tests	7 years ago
Maxime Dor	8a6103798e	Fix for tests	7 years ago
Maxime Dor	bb50ec2e88	Document directory query endpoint	7 years ago
Maxime Dor	1045bc721d	Document federation version endpoint	7 years ago

1 2 3 4

193 Commits (a1a40c63465d5147a7dfbdd8bb781fee3e66df05)