matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
Travis Ralston	7afac76e18	Fix membership state table and diagram (#3730 ) * Fix membership state table and diagram There were 2 missing cases which are legal: * `invite->knock` (a fairly silly thing to do, but legal under the auth rules) * `external->leave (via /kick)` (another somewhat silly thing to do, but no different than `external->ban (via /ban)`) The state table considered the first as illegal, which is untrue. * Changelog * Make the graph prettier * Update changelogs/client_server/newsfragments/3730.clarification Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>	3 years ago
Richard van der Hoff	ca466b5a57	Attempt to clarify how `event_match` works (#3690 ) Fixes #3082, #2637, #3075.	3 years ago
Richard van der Hoff	1913812a90	Clarify send_join response (#3703 )	3 years ago
Andrew Morgan	e7adfd5ed1	Fix missed rst->md numbered list syntax for `m.room.server_acl` (#3681 ) * Fix missed rst->md numbered list syntax	3 years ago
Alexandre Franke	de9cf76a57	Dump additional apis (#3684 ) * ✨ Allow JSON generation for all API Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * 👷 Export AS API JSON Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * ✨ Handle missing security definitions Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * 👷 Export Push Gateway API JSON Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * 🎨 Improve identation Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * 🐛 Fix successive reference handling Fixes #3689 Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * 👷 Export Server-Server API JSON Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * 📝 Remove obsolete comment Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * 🐛 Make properties objects, as they MUST be Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * Revert "👷 Export Server-Server API JSON" This reverts commit `061f91c2cb`. Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>	3 years ago
Richard van der Hoff	36b02edfc2	Distinguish 'client' from 'federation' events (#3658 ) Fixes #3305 Fixes #3380 The idea here is to better distinguish between a 'raw' event (as we send over the wire), and the 'serialised' format, as sent in responses to the C-S api and in `PUT /_matrix/app/v1/transactions/{txnId}`. It's made more complicated by the fact that there are _two_ serialisation formats, one used by `/sync` and `/notifications`, and one by everything else (the difference being whether `room_id` is included). In an ideal world, we wouldn't repeat `SerialisedEvent` every time it's used, and instead just link to the first reference, but that's a job for another day. Another job for another day is to get rid of things like `sync_state_event.yaml` (which is now used only in one place, so should be inlined.)	3 years ago
Aaron Raimist	990dfec94b	Update several spots where C-S API was still using r0 APIs (#3671 ) * Update several spots where C-S API was still using r0 APIs Signed-off-by: Aaron Raimist <aaron@raim.ist> * Add changelog Signed-off-by: Aaron Raimist <aaron@raim.ist>	3 years ago
Alexandre Franke	d3e39567f4	Responses schema fixes (#3650 ) Fixes #2237. Corrects the response schemas for: ``` PUT /user/{user_id}/account_data/{account_dataType} PUT /user/{user_id}/rooms/{roomId}/account_data/{type} PUT /directory/list/room/{roomId} PUT /sendToDevice/{eventType}/{txnId} POST /account/3pid POST /account/3pid/add POST /account/3pid/bind ```	3 years ago
Richard van der Hoff	39a41a18ba	Fix the response for `GET /_matrix/app/v1/thirdparty/protocol/{protocol}` (#3675 ) This should return a single protocol, not all of them. Fixes #2286.	3 years ago
Patrick Cloke	fff5f87c3d	Fix the type of children in the /hierarchy S-S API. (#3660 ) * Fix the type of children in the /hierarchy S-S API. * Newsfragment	3 years ago
Travis Ralston	6c4aabd053	Room versions 8 and 9: Restricted rooms (#3387 ) * Room versions 8 and 9: Restricted rooms MSCs: * https://github.com/matrix-org/matrix-doc/pull/3083 * https://github.com/matrix-org/matrix-doc/pull/3289 * https://github.com/matrix-org/matrix-doc/pull/3375 * Changelogs * Capitalization Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Remove verbiage for spaces because they don't exist * Iterations on text * Another clarification * Make error code descriptions consistent * Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Incorporate from merge * Misc language update per review * Update accuracy before splitting auth rules * fix wtf moment * Fix up v8 and v9 to match "fully specify room versions" * Scope auth events selection to room version * Apply consistency * Add changelogs * Review part 1 * Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Split out redaction sections * Clarify general case of join conditions Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>	3 years ago
Travis Ralston	fc3f7d60eb	Remove `aliases` from `/publicRooms` response (#3624 ) Through attempting to land [Synapse#11667](https://github.com/matrix-org/synapse/pull/11667) it was found that Synapse doesn't return the `aliases` property on `/publicRooms` as it was [removed](https://github.com/matrix-org/synapse/pull/6970) by a [tracking issue](https://github.com/matrix-org/synapse/issues/6898) referencing [MSC2432](https://github.com/matrix-org/matrix-doc/pull/2432) as its base. Though MSC2432 does not make mention of this, the [document](https://docs.google.com/document/d/1NNDkobiFLeUkJtyj0H6qvKIedgvIkZnFKo78-03cGEk/edit) the MSC is based upon makes deliberate effort to mention the endpoint and the removal of `aliases`. Thus, it is determined as a likely accidental omission from the formal MSC and therefore the formal spec. This has been corrected here by amending the MSC (per the process) and removing the field, basing itself off of the [spec PR for spaces](https://github.com/matrix-org/matrix-doc/pull/3610) for diff clarity.	3 years ago
Travis Ralston	9af83dfd41	Add Spaces to the spec (#3610 ) * First iteration of specifying Spaces MSCs: * https://github.com/matrix-org/matrix-doc/pull/3288 * https://github.com/matrix-org/matrix-doc/pull/2946 * https://github.com/matrix-org/matrix-doc/pull/1772 Note that this makes modifications to the underlying MSCs as well. These are intended to be minor edits to aid clarity/accuracy of the MSCs, as per the proposal process. Functionally, clients and servers might need to change their behaviour slightly as is expected of implementing this stuff early. Synapse has these changes (alongside backwards compatibility) here: https://github.com/matrix-org/synapse/pull/11667 * add changelogs * Accuracy per review * Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * fully prefix new endpoints * Fully prefix endpoint in 3616 too * Fix ordering example Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>	3 years ago
Hubert Chathi	6fb684397a	Clarify how to interpret missing one time key counts (#3636 )	3 years ago
Travis Ralston	56532dd688	Describe and hoist stripped state to a first-class citizen (#3606 ) * Describe and hoist stripped state to a first-class citizen Fixes https://github.com/matrix-org/matrix-doc/issues/3413 MSC: https://github.com/matrix-org/matrix-doc/pull/3173 * Add changelog * may->can for clarity * Update text per review	3 years ago
Travis Ralston	224773dc6a	Specify fallback keys (#3615 ) * Specify fallback keys MSC: https://github.com/matrix-org/matrix-doc/pull/2732 * changelog * Appease spell check * Fine, let's appease the spellcheck this way * Apply suggestions from code review Co-authored-by: Hubert Chathi <hubert@uhoreg.ca> * Fix intro * word wrap Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>	3 years ago
Travis Ralston	26e0765159	Add guest changes to spec: MSC3069 and MSC3419 (#3605 ) * Add MSC3069 support https://github.com/matrix-org/matrix-doc/pull/3069 * Add MSC3419 support https://github.com/matrix-org/matrix-doc/pull/3419 * Normalize and fix guest access endpoints list * Changelogs	3 years ago
Travis Ralston	e4057072bd	Add registration token UIA type (#3616 ) * Add registration token UIA type MSC: https://github.com/matrix-org/matrix-doc/pull/3231 Note: This introduces the endpoint as v1 rather than r0 given the global versioning changes landed between the acceptance of the MSC and now. * Fix swagger * Changelogs * Update data/api/client-server/registration_tokens.yaml Co-authored-by: Hubert Chathi <hubert@uhoreg.ca> Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>	3 years ago
Richard van der Hoff	355e06eaa6	Clarification for `/event_auth` (#3583 ) The description on this endpoint implied it returned the auth chain for the full state of the room, which is incorrect.	3 years ago
Travis Ralston	1e9dd4d22e	Avoid use of the word "clobber" (#3611 ) * Avoid use of the word "clobber" Fixes https://github.com/matrix-org/matrix-doc/issues/1328 * changelog	3 years ago
Dan Callahan	48d8f7202d	Add HTTP 403 to possible profile responses (#3530 ) * Add HTTP 403 to possible profile responses Some servers may not allow profile lookup over federation, and thus respond to GET /_matrix/client/v3/profile/{userId} with an HTTP 403. For example, Synapse can be configured to behave in this way by setting: allow_profile_lookup_over_federation=false Thus, this behavior already exists in the wild, and may cause issues for clients such as https://github.com/vector-im/element-web/issues/17269. Synapse could alter its behavior and return an HTTP 404 in these cases, but amending the Spec seems preferable to align with extant behavior. Further, allowing HTTP 403 gives clients more specific information as to why a request has failed, enabling more precise error handling. Signed-off-by: Dan Callahan <danc@element.io> * Update changelogs/client_server/newsfragments/3530.clarification Co-authored-by: Travis Ralston <travpc@gmail.com> * Annotate misc data about error Co-authored-by: Travis Ralston <travpc@gmail.com> Co-authored-by: Travis Ralston <travisr@matrix.org>	3 years ago
Aaron Raimist	01cd41de68	Add GitHub Action to check spelling (#3591 ) Signed-off-by: Aaron Raimist <aaron@raim.ist>	3 years ago
Travis Ralston	0fbc6bdab6	Definition of "Standard Identifier Format" (#3171 ) Spec for https://github.com/matrix-org/matrix-doc/pull/2758	3 years ago
Richard van der Hoff	83b24dd54d	Remove definition of Event for `/notifications` (#3525 ) The documentation for the `/notifications` API had its own special definition of what an Event was, which was used nowhere else. The common definition isn't perfect, but it is common, so it gives us a better starting place for improvement.	3 years ago
Richard van der Hoff	7f200c53e8	Move `prev_content` to unsigned (#3524 )	3 years ago
Richard van der Hoff	dce06f6dc2	Remove C-S `unsigned` data from PDU definitions (#3522 ) Remove a bunch of fields from the `unsigned` property of PDUs. These things shouldn't be passed over the Federation API, and they really shouldn't be trusted if they are sent by another server. * `replaces_state` is returned by Synapse, but probably shouldn't be. * `redacted_because`, `prev_sender` and `prev_content` are not sent by Synapse.	3 years ago
Ankur	ac98c8c08c	OpenAPI: Add missing `required` flag in `getRoomKeys` (#3509 )	3 years ago
Ankur	a8cf4d4a56	Open API: Changed RoomKeys to RoomKey (#3500 )	3 years ago
Will Hunt	51d8560da9	Explicitly link to geo URI spec (#3492 ) * Explicitly link to geo URI spec * move RFC location Co-authored-by: Travis Ralston <travisr@matrix.org> * Create 3492.clarification Co-authored-by: Travis Ralston <travisr@matrix.org>	3 years ago
Ankur	a034d45e45	typos: Corrected typos in message_pagination.yaml (#3495 )	3 years ago
Hubert Chathi	033038917d	remove extra `type` property (#3482 )	3 years ago
Travis Ralston	5ea6d5610f	Update identity server spec to use global versioning (#3459 ) * Update identity server spec to use global versioning * changelog	3 years ago
Travis Ralston	5be0df02c5	Start annotating which version of the spec added a thing (#3425 ) * Introduce a new "added-in" template and use it on endpoints * Use "added-in" on schema properties too * Annotate sections of the spec with their added versions * Demo of "added-in" on a room version (to be fleshed out) * Use clearer versioning semantics * Update and fix validator for Swagger custom properties * Fix docs	3 years ago
Travis Ralston	649fc2bdd2	Move room version spec to `/rooms` (#3423 ) * Cut/paste room version spec to its own page * Move grammar to bottom + add feature matrix The version grammar is not as interesting as the actual room versions, so this moves that whole section to the bottom. * Fix all links to room versions	3 years ago
Travis Ralston	95d850c418	Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421 ) * Blind find & replace all on client major version -> v3 * Fix up bad replacements * Fix anchors for r0->v3 * Changelog	3 years ago
Travis Ralston	2d98cd3084	Describe new global specification versioning (#3420 ) * Update versioning specification for Matrix As per [MSC2844](https://github.com/matrix-org/matrix-doc/pull/2844) * Mention vX versioning in /versions * Changelog	3 years ago
Andrew Fargo	f1a4a58755	Fix "invite_state" to "knock_state" (#3428 )	3 years ago
Aaron Raimist	525728971b	Fix two links on the CS API page Signed-off-by: Aaron Raimist <aaron@raim.ist>	3 years ago
Richard van der Hoff	6bd7b6cbb5	Clarifications to pagination parameters for various APIs (#3353 )	3 years ago
Lukas Lihotzki	8a8db03a13	OpenAPI: include peekEvents Disambiguate from getEvents by a trailing space in path (like inviteUser). Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>	3 years ago
Denis Kasak	ddbbd76b32	Fix typo in /_matrix/client/r0/account/3pid/delete.	3 years ago
Hubert Chathi	b231220bbd	Merge pull request #3337 from uhoreg/room_create_canonical_alias room creation: create canonical alias event if alias specified	3 years ago
Alexey Rusakov	fbf4259a83	Merge pull request #3330 from lukaslihotzki/add-titles OpenAPI: add titles	3 years ago
Hubert Chathi	8536cd3e16	drop initial state check	3 years ago
Alexey Rusakov	5749325fc3	Merge pull request #3329 from lukaslihotzki/missing-tags OpenAPI: improve tags	3 years ago
Lukas Lihotzki	13f7df1379	OpenAPI: add titles	3 years ago
Hubert Chathi	89089e8913	Merge pull request #3332 from lukaslihotzki/required-bodies OpenAPI: require all bodies in cross_signing	3 years ago
Lukas Lihotzki	39e70a2902	OpenAPI: split User data tag Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>	3 years ago
Hubert Chathi	ee92c94cfe	Mention that a canonical alias event should be created if alias specified	3 years ago
Lukas Lihotzki	1a81a46865	OpenAPI: require all bodies in cross_signing Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>	3 years ago

1 2

94 Commits (7afac76e18f4b90681b86658a379d16811ad199a)