Commit Graph

31 Commits (649fc2bdd24435813b893aefe21be2f7b5e17fd5)

Author SHA1 Message Date
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