matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
Will Hunt	c420fc49a0	Fix m.login.appservice -> m.login.application_service (#3711 ) * Fix m.login.appservice -> m.login.application_service Implementations seem to agree with the proposal, so I'd suggest we fix the typo in the spec. I don't think this needs a MSC as the original proposal was fine, and this was just a copy error. * Create 3711.clarification * Update 3711.clarification * Update changelogs/3711.clarification Co-authored-by: Travis Ralston <travisr@matrix.org> Co-authored-by: Travis Ralston <travisr@matrix.org>	2 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.)	2 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>	2 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>	2 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>	2 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	2 years ago
Travis Ralston	00169abcdb	Specify module order manually to work around hugo issues (#3612 )	2 years ago
Travis Ralston	0ee58100c4	Add capabilities described by MSC3283 (#3614 ) * Add capabilities described by MSC3283 MSC: https://github.com/matrix-org/matrix-doc/pull/3283 * changelog	2 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>	2 years ago
Travis Ralston	afb6867232	Decorate the rest of the appservice login stuff too	2 years ago
Will Hunt	a05706780d	Add m.login.appservice to the spec (#3324 ) Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Co-authored-by: Hubert Chathi <hubertc@matrix.org> Co-authored-by: Travis Ralston <travisr@matrix.org>	2 years ago
Shay	87fcb7c8b0	Clarify that `base_url` in client `well_known` may or may not include trailing slash (#3562 ) Fixes #3465. The change adds a line explicitly warning developers that the base_url of client well_known may or may not include a trailing slash and to be prepared to handle both cases.	2 years ago
Richard van der Hoff	7f200c53e8	Move `prev_content` to unsigned (#3524 )	3 years ago
David Robertson	1e12b45f97	Clarifications to /sync description (#3534 ) * Clarify that E0 and E1 are not returned * Clarify that ASCII art diagram 2 refers to diagram 1 * Correct third ASCII art diagram To match the spacing in. Borked in the move to new docs format. `55aed1d296/specification/client_server_api.rst (L1610-L1615)` * Make ASCII art 3 follow from ASCII art 2 * Explain how to fill the gap * Create 3543.clarification * Update content/client-server-api/_index.md Co-authored-by: Travis Ralston <travisr@matrix.org>	3 years ago
DeepBlueV7.X	938354b8b4	Rename threepidCreds to threepid_creds and get rid of array (#3471 ) This fixes the behaviour to match what synapse implements in practice. If you use threepidCreds, you will just get an error about a missing threepid_creds field. Synapse also treats this as an object. All clients also seem to send threepid_creds, if they work on Synapse. Since matrix.org requires an email currently for registration, most clients that implement registration, will hit this issue. `a0f48ee89d/synapse/handlers/ui_auth/checkers.py (L145)` fixes #3156 fixes #2189 Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>	3 years ago
Travis Ralston	241e01c332	Fully specify room versions (#3432 ) * Fully specify room versions * Misc typo clarifications * Try to clarify redactions a bit * Update content/client-server-api/_index.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update content/rooms/v6.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update content/rooms/v6.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Better describe client considerations * Doc template params * Move redaction "new stuff" to v3 * Remove unhelpful sentences about "here follows unchanged stuff" * Simplify event signing text * Clean up handling redactions sections * Move v4's event schema to unchanged section * Update content/rooms/v4.md 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
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	7e67aa2e23	Clarify how redacted_because actually works for events (#3411 ) * Clarify how redacted_because actually works for events * changelog * mention federation * Fix wording 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	f8b83b7fb1	Replace "Pagination" section in C-S API with text in appendices (#3366 ) The Pagination section in the C-S API was, basically, full of rubbish. I think that anything of any value it contained was repeated either directly on the API definitions or in the text specific to syncing at https://spec.matrix.org/unstable/client-server-api/#syncing. The conventions I've added to the Appendices are based on the discussions in #1898. They are there because I don't want to have to go through it all again next time we add a paginated API. Fixes: #1898 Fixes: #2268	3 years ago
Richard van der Hoff	4b2bbbabcc	Start a 'conventions' section in the Appendices (#3350 ) I wanted a section for "here's what new APIs ought to do", which isn't really very useful for consumers of the existing APIs.	3 years ago
Michael[tm] Smith	d7cf63d981	Drop Origin & Accept from Access-Control-Allow-Headers value This change drops the Origin and Accept header names from the recommended value for the CORS Access-Control-Allow-Headers header. Per the CORS protocol, it’s not necessary or useful to include them. Per-spec at https://fetch.spec.whatwg.org/#forbidden-header-name, Origin is a “forbidden header name” set by the browser and that frontend JavaScript code is never allowed to set. So the value of Access-Control-Allow-Headers isn’t relevant to Origin or in general to other headers set by the browser itself — the browser never ever consults the Access-Control-Allow-Headers value to confirm that it’s OK for the request to include an Origin header. And per-spec at https://fetch.spec.whatwg.org/#cors-safelisted-request-header, Accept is a “CORS-safelisted request-header”, which means that browsers allow requests to contain the Accept header regardless of whether the Access-Control-Allow-Headers value contains "Accept". So it’s unnecessary for the Access-Control-Allow-Headers to explicitly include Accept. Browsers will not perform a CORS preflight for requests containing an Accept request header. Related: Related: https://github.com/matrix-org/synapse/pull/10114 Signed-off-by: Michael[tm] Smith <mike@w3.org>	3 years ago
Travis Ralston	466911b253	Merge pull request #3170 from matrix-org/travis/spec/msc2713-rm-v1-id Remove v1 identity service API	3 years ago
Travis Ralston	37c3a3f855	Remove v1 identity service API Spec for https://github.com/matrix-org/matrix-doc/pull/2713	3 years ago
Travis Ralston	49a5ca3553	Downgrade identity server failure to FAIL_PROMPT instead of FAIL_ERROR Spec for https://github.com/matrix-org/matrix-doc/pull/2284	3 years ago
Travis Ralston	57f4347b5d	Fix general wording	3 years ago
Travis Ralston	fa6cc8a1ff	Add knocking to the spec Spec for https://github.com/matrix-org/matrix-doc/pull/2998 Spec for https://github.com/matrix-org/matrix-doc/pull/2403 This deliberately does not help towards fixing https://github.com/matrix-org/matrix-doc/issues/3153 in order to remain consistent with prior room versions, and to keep the diff smaller on this change. A future change will address room version legibility.	3 years ago
Travis Ralston	a855ed338b	Fix event size restriction (#3127 ) Fixes https://github.com/matrix-org/matrix-doc/issues/3126	3 years ago
Travis Ralston	5d2cb50c58	Apply suggestions from code review Co-authored-by: Matthew Hodgson <matthew@matrix.org>	3 years ago
Travis Ralston	30f37f1e66	Sprinkle some DANGER: UNSAFE warnings over the spec about event bodies Specs [MSC2801](https://github.com/matrix-org/matrix-doc/pull/2801) Based on https://github.com/matrix-org/matrix-doc/pull/3094	3 years ago
Will	9a179038cc	Fix links to rendered APIs	3 years ago
Will	72ff5b92cb	Update content to call the new template for event definitions	3 years ago
Will	52f5e73a39	Update content to call the new template for HTTP APIs	3 years ago
Will	ea9fced092	Formatting fixes for the authentication section	3 years ago
Will	86152613b1	Remove changelog sections	3 years ago
Will	52745160f3	Use GFM table syntax instead of raw HTML	3 years ago
Will	02a41edc76	Fix heading levels	3 years ago
Will	4e39200cfa	Fix internal links	3 years ago
Will	338434bfcd	Support alerts (notes, warnings, rationales)	3 years ago
Will	ab64bda76d	Add syntax highlighting	3 years ago
Will	6c6bd57ebf	Fix ASCII diagrams	3 years ago
Will	55aed1d296	Remove 'unstable' warning	3 years ago
Will	228c737f56	Add support for modules	3 years ago
Will	74adbfc1ec	Remove 'Table of Contents'	3 years ago
Will	9d4803c8af	Remove duplicate titles	3 years ago
Will	c924b3246f	Add page content as raw Pandoc output	3 years ago
Will	ebc6db233b	Add empty page placeholders	3 years ago

48 Commits (b26aa7fcf541a4e23ac5c8a16b8d609c8c63b005)